From b60a36f00920515f2b1033a55b6be5696c6433f9 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 16 Sep 2022 15:36:19 +0000 Subject: [PATCH] feat: Add support for REST transport (#184) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 474644226 Source-Link: https://github.com/googleapis/googleapis/commit/f90b329a7eb583a21a20796892b993e91e8ccf34 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4ad8763bde676f92a3eb70753ae1cfed0e81387e Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGFkODc2M2JkZTY3NmY5MmEzZWI3MDc1M2FlMWNmZWQwZTgxMzg3ZSJ9 PiperOrigin-RevId: 474571730 Source-Link: https://github.com/googleapis/googleapis/commit/5a9ee4d5deca8e3da550b0419ed336e22521fc8e Source-Link: https://github.com/googleapis/googleapis-gen/commit/ceafe521f137680fdee2f9ca9e1947cdd825070d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiY2VhZmU1MjFmMTM3NjgwZmRlZTJmOWNhOWUxOTQ3Y2RkODI1MDcwZCJ9 fix(deps): require google-api-core>=1.33.1,>=2.8.0 fix(deps): require protobuf >= 3.20.1 --- .../gapic_metadata.json | 95 + .../services/catalog_service/client.py | 5 + .../catalog_service/transports/__init__.py | 5 + .../catalog_service/transports/rest.py | 990 ++++++++ .../prediction_api_key_registry/client.py | 5 + .../transports/__init__.py | 5 + .../transports/rest.py | 604 +++++ .../services/prediction_service/client.py | 5 + .../prediction_service/transports/__init__.py | 5 + .../prediction_service/transports/rest.py | 323 +++ .../services/user_event_service/client.py | 5 + .../user_event_service/transports/__init__.py | 5 + .../user_event_service/transports/rest.py | 944 +++++++ ...rvice_create_catalog_item_sync_b388a984.py | 58 + ...rvice_create_catalog_item_sync_d75dfd44.py | 58 + ...rvice_delete_catalog_item_sync_66bf5928.py | 50 + ...rvice_delete_catalog_item_sync_8be644dc.py | 50 + ..._service_get_catalog_item_sync_4ea33c38.py | 52 + ..._service_get_catalog_item_sync_7d3f85d9.py | 52 + ...vice_import_catalog_items_sync_d3c3edf0.py | 56 + ...vice_import_catalog_items_sync_e3f144cd.py | 56 + ...ervice_list_catalog_items_sync_2bf256a9.py | 53 + ...ervice_list_catalog_items_sync_a2793df4.py | 53 + ...rvice_update_catalog_item_sync_266ee256.py | 58 + ...rvice_update_catalog_item_sync_abe0821d.py | 58 + ...tion_api_key_registration_sync_8ddf5d36.py | 52 + ...tion_api_key_registration_sync_c078ad83.py | 52 + ...tion_api_key_registration_sync_3de55013.py | 50 + ...tion_api_key_registration_sync_f40a4844.py | 50 + ...ion_api_key_registrations_sync_2d26cba1.py | 53 + ...ion_api_key_registrations_sync_4cdac270.py | 53 + ...rediction_service_predict_sync_31326670.py | 58 + ...rediction_service_predict_sync_a38ea195.py | 58 + ...ervice_collect_user_event_sync_9128505b.py | 53 + ...ervice_collect_user_event_sync_beed3ba7.py | 53 + ...ervice_import_user_events_sync_1b260921.py | 56 + ...ervice_import_user_events_sync_202fd725.py | 56 + ..._service_list_user_events_sync_ccefa7ab.py | 53 + ..._service_list_user_events_sync_d6baec98.py | 53 + ...service_purge_user_events_sync_37388c66.py | 57 + ...service_purge_user_events_sync_bd0d439c.py | 57 + ..._service_write_user_event_sync_62b9e427.py | 57 + ..._service_write_user_event_sync_b58371f7.py | 57 + ...metadata_recommendationengine_v1beta1.json | 2040 ++++++++++++--- .../google-cloud-recommendations-ai/setup.py | 4 +- .../testing/constraints-3.7.txt | 4 +- .../test_catalog_service.py | 2198 ++++++++++++++++- .../test_prediction_api_key_registry.py | 1083 +++++++- .../test_prediction_service.py | 446 +++- .../test_user_event_service.py | 2025 +++++++++++++-- 50 files changed, 11772 insertions(+), 656 deletions(-) create mode 100644 packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/rest.py create mode 100644 packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/rest.py create mode 100644 packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/rest.py create mode 100644 packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/rest.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py create mode 100644 packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/gapic_metadata.json b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/gapic_metadata.json index b5ae877ca098..63ee770dcdaf 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/gapic_metadata.json +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/gapic_metadata.json @@ -76,6 +76,41 @@ ] } } + }, + "rest": { + "libraryClient": "CatalogServiceClient", + "rpcs": { + "CreateCatalogItem": { + "methods": [ + "create_catalog_item" + ] + }, + "DeleteCatalogItem": { + "methods": [ + "delete_catalog_item" + ] + }, + "GetCatalogItem": { + "methods": [ + "get_catalog_item" + ] + }, + "ImportCatalogItems": { + "methods": [ + "import_catalog_items" + ] + }, + "ListCatalogItems": { + "methods": [ + "list_catalog_items" + ] + }, + "UpdateCatalogItem": { + "methods": [ + "update_catalog_item" + ] + } + } } } }, @@ -120,6 +155,26 @@ ] } } + }, + "rest": { + "libraryClient": "PredictionApiKeyRegistryClient", + "rpcs": { + "CreatePredictionApiKeyRegistration": { + "methods": [ + "create_prediction_api_key_registration" + ] + }, + "DeletePredictionApiKeyRegistration": { + "methods": [ + "delete_prediction_api_key_registration" + ] + }, + "ListPredictionApiKeyRegistrations": { + "methods": [ + "list_prediction_api_key_registrations" + ] + } + } } } }, @@ -144,6 +199,16 @@ ] } } + }, + "rest": { + "libraryClient": "PredictionServiceClient", + "rpcs": { + "Predict": { + "methods": [ + "predict" + ] + } + } } } }, @@ -208,6 +273,36 @@ ] } } + }, + "rest": { + "libraryClient": "UserEventServiceClient", + "rpcs": { + "CollectUserEvent": { + "methods": [ + "collect_user_event" + ] + }, + "ImportUserEvents": { + "methods": [ + "import_user_events" + ] + }, + "ListUserEvents": { + "methods": [ + "list_user_events" + ] + }, + "PurgeUserEvents": { + "methods": [ + "purge_user_events" + ] + }, + "WriteUserEvent": { + "methods": [ + "write_user_event" + ] + } + } } } } diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py index f76be9b6228c..652263bdf0d1 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py @@ -45,6 +45,7 @@ from .transports.base import CatalogServiceTransport, DEFAULT_CLIENT_INFO from .transports.grpc import CatalogServiceGrpcTransport from .transports.grpc_asyncio import CatalogServiceGrpcAsyncIOTransport +from .transports.rest import CatalogServiceRestTransport class CatalogServiceClientMeta(type): @@ -60,6 +61,7 @@ class CatalogServiceClientMeta(type): ) # type: Dict[str, Type[CatalogServiceTransport]] _transport_registry["grpc"] = CatalogServiceGrpcTransport _transport_registry["grpc_asyncio"] = CatalogServiceGrpcAsyncIOTransport + _transport_registry["rest"] = CatalogServiceRestTransport def get_transport_class( cls, @@ -355,6 +357,9 @@ def __init__( transport (Union[str, CatalogServiceTransport]): The transport to use. If set to None, a transport is chosen automatically. + NOTE: "rest" transport functionality is currently in a + beta state (preview). We welcome your feedback via an + issue in this library's source repository. client_options (google.api_core.client_options.ClientOptions): Custom options for the client. It won't take effect if a ``transport`` instance is provided. (1) The ``api_endpoint`` property can be used to override the diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/__init__.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/__init__.py index 6b59e0703353..28f8d293645f 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/__init__.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/__init__.py @@ -19,15 +19,20 @@ from .base import CatalogServiceTransport from .grpc import CatalogServiceGrpcTransport from .grpc_asyncio import CatalogServiceGrpcAsyncIOTransport +from .rest import CatalogServiceRestTransport +from .rest import CatalogServiceRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[CatalogServiceTransport]] _transport_registry["grpc"] = CatalogServiceGrpcTransport _transport_registry["grpc_asyncio"] = CatalogServiceGrpcAsyncIOTransport +_transport_registry["rest"] = CatalogServiceRestTransport __all__ = ( "CatalogServiceTransport", "CatalogServiceGrpcTransport", "CatalogServiceGrpcAsyncIOTransport", + "CatalogServiceRestTransport", + "CatalogServiceRestInterceptor", ) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/rest.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/rest.py new file mode 100644 index 000000000000..5e261ef59b2f --- /dev/null +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/catalog_service/transports/rest.py @@ -0,0 +1,990 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.recommendationengine_v1beta1.types import catalog +from google.cloud.recommendationengine_v1beta1.types import catalog_service +from google.cloud.recommendationengine_v1beta1.types import import_ +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import empty_pb2 # type: ignore + +from .base import ( + CatalogServiceTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class CatalogServiceRestInterceptor: + """Interceptor for CatalogService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the CatalogServiceRestTransport. + + .. code-block:: python + class MyCustomCatalogServiceInterceptor(CatalogServiceRestInterceptor): + def pre_create_catalog_item(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_catalog_item(response): + logging.log(f"Received response: {response}") + + def pre_delete_catalog_item(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_catalog_item(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_catalog_item(response): + logging.log(f"Received response: {response}") + + def pre_import_catalog_items(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_catalog_items(response): + logging.log(f"Received response: {response}") + + def pre_list_catalog_items(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_catalog_items(response): + logging.log(f"Received response: {response}") + + def pre_update_catalog_item(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_catalog_item(response): + logging.log(f"Received response: {response}") + + transport = CatalogServiceRestTransport(interceptor=MyCustomCatalogServiceInterceptor()) + client = CatalogServiceClient(transport=transport) + + + """ + + def pre_create_catalog_item( + self, + request: catalog_service.CreateCatalogItemRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[catalog_service.CreateCatalogItemRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_catalog_item + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def post_create_catalog_item( + self, response: catalog.CatalogItem + ) -> catalog.CatalogItem: + """Post-rpc interceptor for create_catalog_item + + Override in a subclass to manipulate the response + after it is returned by the CatalogService server but before + it is returned to user code. + """ + return response + + def pre_delete_catalog_item( + self, + request: catalog_service.DeleteCatalogItemRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[catalog_service.DeleteCatalogItemRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_catalog_item + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def pre_get_catalog_item( + self, + request: catalog_service.GetCatalogItemRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[catalog_service.GetCatalogItemRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_catalog_item + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def post_get_catalog_item( + self, response: catalog.CatalogItem + ) -> catalog.CatalogItem: + """Post-rpc interceptor for get_catalog_item + + Override in a subclass to manipulate the response + after it is returned by the CatalogService server but before + it is returned to user code. + """ + return response + + def pre_import_catalog_items( + self, + request: import_.ImportCatalogItemsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[import_.ImportCatalogItemsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for import_catalog_items + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def post_import_catalog_items( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for import_catalog_items + + Override in a subclass to manipulate the response + after it is returned by the CatalogService server but before + it is returned to user code. + """ + return response + + def pre_list_catalog_items( + self, + request: catalog_service.ListCatalogItemsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[catalog_service.ListCatalogItemsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_catalog_items + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def post_list_catalog_items( + self, response: catalog_service.ListCatalogItemsResponse + ) -> catalog_service.ListCatalogItemsResponse: + """Post-rpc interceptor for list_catalog_items + + Override in a subclass to manipulate the response + after it is returned by the CatalogService server but before + it is returned to user code. + """ + return response + + def pre_update_catalog_item( + self, + request: catalog_service.UpdateCatalogItemRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[catalog_service.UpdateCatalogItemRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_catalog_item + + Override in a subclass to manipulate the request or metadata + before they are sent to the CatalogService server. + """ + return request, metadata + + def post_update_catalog_item( + self, response: catalog.CatalogItem + ) -> catalog.CatalogItem: + """Post-rpc interceptor for update_catalog_item + + Override in a subclass to manipulate the response + after it is returned by the CatalogService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class CatalogServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: CatalogServiceRestInterceptor + + +class CatalogServiceRestTransport(CatalogServiceTransport): + """REST backend transport for CatalogService. + + Service for ingesting catalog information of the customer's + website. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via an issue in this + library's source repository. Thank you! + """ + + def __init__( + self, + *, + host: str = "recommendationengine.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[CatalogServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via a GitHub issue in + this library's repository. Thank you! + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or CatalogServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _CreateCatalogItem(CatalogServiceRestStub): + def __hash__(self): + return hash("CreateCatalogItem") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: catalog_service.CreateCatalogItemRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> catalog.CatalogItem: + r"""Call the create catalog item method over HTTP. + + Args: + request (~.catalog_service.CreateCatalogItemRequest): + The request object. Request message for CreateCatalogItem + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.catalog.CatalogItem: + CatalogItem captures all metadata + information of items to be recommended. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems", + "body": "catalog_item", + }, + ] + request, metadata = self._interceptor.pre_create_catalog_item( + request, metadata + ) + pb_request = catalog_service.CreateCatalogItemRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = catalog.CatalogItem() + pb_resp = catalog.CatalogItem.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_catalog_item(resp) + return resp + + class _DeleteCatalogItem(CatalogServiceRestStub): + def __hash__(self): + return hash("DeleteCatalogItem") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: catalog_service.DeleteCatalogItemRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete catalog item method over HTTP. + + Args: + request (~.catalog_service.DeleteCatalogItemRequest): + The request object. Request message for DeleteCatalogItem + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}", + }, + ] + request, metadata = self._interceptor.pre_delete_catalog_item( + request, metadata + ) + pb_request = catalog_service.DeleteCatalogItemRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetCatalogItem(CatalogServiceRestStub): + def __hash__(self): + return hash("GetCatalogItem") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: catalog_service.GetCatalogItemRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> catalog.CatalogItem: + r"""Call the get catalog item method over HTTP. + + Args: + request (~.catalog_service.GetCatalogItemRequest): + The request object. Request message for GetCatalogItem + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.catalog.CatalogItem: + CatalogItem captures all metadata + information of items to be recommended. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}", + }, + ] + request, metadata = self._interceptor.pre_get_catalog_item( + request, metadata + ) + pb_request = catalog_service.GetCatalogItemRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = catalog.CatalogItem() + pb_resp = catalog.CatalogItem.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_catalog_item(resp) + return resp + + class _ImportCatalogItems(CatalogServiceRestStub): + def __hash__(self): + return hash("ImportCatalogItems") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: import_.ImportCatalogItemsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the import catalog items method over HTTP. + + Args: + request (~.import_.ImportCatalogItemsRequest): + The request object. Request message for Import methods. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems:import", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_import_catalog_items( + request, metadata + ) + pb_request = import_.ImportCatalogItemsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_catalog_items(resp) + return resp + + class _ListCatalogItems(CatalogServiceRestStub): + def __hash__(self): + return hash("ListCatalogItems") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: catalog_service.ListCatalogItemsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> catalog_service.ListCatalogItemsResponse: + r"""Call the list catalog items method over HTTP. + + Args: + request (~.catalog_service.ListCatalogItemsRequest): + The request object. Request message for ListCatalogItems + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.catalog_service.ListCatalogItemsResponse: + Response message for ListCatalogItems + method. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems", + }, + ] + request, metadata = self._interceptor.pre_list_catalog_items( + request, metadata + ) + pb_request = catalog_service.ListCatalogItemsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = catalog_service.ListCatalogItemsResponse() + pb_resp = catalog_service.ListCatalogItemsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_catalog_items(resp) + return resp + + class _UpdateCatalogItem(CatalogServiceRestStub): + def __hash__(self): + return hash("UpdateCatalogItem") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: catalog_service.UpdateCatalogItemRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> catalog.CatalogItem: + r"""Call the update catalog item method over HTTP. + + Args: + request (~.catalog_service.UpdateCatalogItemRequest): + The request object. Request message for UpdateCatalogItem + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.catalog.CatalogItem: + CatalogItem captures all metadata + information of items to be recommended. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}", + "body": "catalog_item", + }, + ] + request, metadata = self._interceptor.pre_update_catalog_item( + request, metadata + ) + pb_request = catalog_service.UpdateCatalogItemRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = catalog.CatalogItem() + pb_resp = catalog.CatalogItem.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_catalog_item(resp) + return resp + + @property + def create_catalog_item( + self, + ) -> Callable[[catalog_service.CreateCatalogItemRequest], catalog.CatalogItem]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateCatalogItem(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_catalog_item( + self, + ) -> Callable[[catalog_service.DeleteCatalogItemRequest], empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteCatalogItem(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_catalog_item( + self, + ) -> Callable[[catalog_service.GetCatalogItemRequest], catalog.CatalogItem]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetCatalogItem(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_catalog_items( + self, + ) -> Callable[[import_.ImportCatalogItemsRequest], operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ImportCatalogItems(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_catalog_items( + self, + ) -> Callable[ + [catalog_service.ListCatalogItemsRequest], + catalog_service.ListCatalogItemsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListCatalogItems(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_catalog_item( + self, + ) -> Callable[[catalog_service.UpdateCatalogItemRequest], catalog.CatalogItem]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateCatalogItem(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("CatalogServiceRestTransport",) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py index 3a61f81737e7..24534ccedd89 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/client.py @@ -43,6 +43,7 @@ from .transports.base import PredictionApiKeyRegistryTransport, DEFAULT_CLIENT_INFO from .transports.grpc import PredictionApiKeyRegistryGrpcTransport from .transports.grpc_asyncio import PredictionApiKeyRegistryGrpcAsyncIOTransport +from .transports.rest import PredictionApiKeyRegistryRestTransport class PredictionApiKeyRegistryClientMeta(type): @@ -58,6 +59,7 @@ class PredictionApiKeyRegistryClientMeta(type): ) # type: Dict[str, Type[PredictionApiKeyRegistryTransport]] _transport_registry["grpc"] = PredictionApiKeyRegistryGrpcTransport _transport_registry["grpc_asyncio"] = PredictionApiKeyRegistryGrpcAsyncIOTransport + _transport_registry["rest"] = PredictionApiKeyRegistryRestTransport def get_transport_class( cls, @@ -385,6 +387,9 @@ def __init__( transport (Union[str, PredictionApiKeyRegistryTransport]): The transport to use. If set to None, a transport is chosen automatically. + NOTE: "rest" transport functionality is currently in a + beta state (preview). We welcome your feedback via an + issue in this library's source repository. client_options (google.api_core.client_options.ClientOptions): Custom options for the client. It won't take effect if a ``transport`` instance is provided. (1) The ``api_endpoint`` property can be used to override the diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/__init__.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/__init__.py index 4662b6dbe616..e558f8db0698 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/__init__.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/__init__.py @@ -19,6 +19,8 @@ from .base import PredictionApiKeyRegistryTransport from .grpc import PredictionApiKeyRegistryGrpcTransport from .grpc_asyncio import PredictionApiKeyRegistryGrpcAsyncIOTransport +from .rest import PredictionApiKeyRegistryRestTransport +from .rest import PredictionApiKeyRegistryRestInterceptor # Compile a registry of transports. @@ -27,9 +29,12 @@ ) # type: Dict[str, Type[PredictionApiKeyRegistryTransport]] _transport_registry["grpc"] = PredictionApiKeyRegistryGrpcTransport _transport_registry["grpc_asyncio"] = PredictionApiKeyRegistryGrpcAsyncIOTransport +_transport_registry["rest"] = PredictionApiKeyRegistryRestTransport __all__ = ( "PredictionApiKeyRegistryTransport", "PredictionApiKeyRegistryGrpcTransport", "PredictionApiKeyRegistryGrpcAsyncIOTransport", + "PredictionApiKeyRegistryRestTransport", + "PredictionApiKeyRegistryRestInterceptor", ) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/rest.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/rest.py new file mode 100644 index 000000000000..397c7f6e0c17 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_api_key_registry/transports/rest.py @@ -0,0 +1,604 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.recommendationengine_v1beta1.types import ( + prediction_apikey_registry_service, +) +from google.protobuf import empty_pb2 # type: ignore + +from .base import ( + PredictionApiKeyRegistryTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class PredictionApiKeyRegistryRestInterceptor: + """Interceptor for PredictionApiKeyRegistry. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the PredictionApiKeyRegistryRestTransport. + + .. code-block:: python + class MyCustomPredictionApiKeyRegistryInterceptor(PredictionApiKeyRegistryRestInterceptor): + def pre_create_prediction_api_key_registration(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_prediction_api_key_registration(response): + logging.log(f"Received response: {response}") + + def pre_delete_prediction_api_key_registration(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_list_prediction_api_key_registrations(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_prediction_api_key_registrations(response): + logging.log(f"Received response: {response}") + + transport = PredictionApiKeyRegistryRestTransport(interceptor=MyCustomPredictionApiKeyRegistryInterceptor()) + client = PredictionApiKeyRegistryClient(transport=transport) + + + """ + + def pre_create_prediction_api_key_registration( + self, + request: prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for create_prediction_api_key_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the PredictionApiKeyRegistry server. + """ + return request, metadata + + def post_create_prediction_api_key_registration( + self, response: prediction_apikey_registry_service.PredictionApiKeyRegistration + ) -> prediction_apikey_registry_service.PredictionApiKeyRegistration: + """Post-rpc interceptor for create_prediction_api_key_registration + + Override in a subclass to manipulate the response + after it is returned by the PredictionApiKeyRegistry server but before + it is returned to user code. + """ + return response + + def pre_delete_prediction_api_key_registration( + self, + request: prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for delete_prediction_api_key_registration + + Override in a subclass to manipulate the request or metadata + before they are sent to the PredictionApiKeyRegistry server. + """ + return request, metadata + + def pre_list_prediction_api_key_registrations( + self, + request: prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[ + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, + Sequence[Tuple[str, str]], + ]: + """Pre-rpc interceptor for list_prediction_api_key_registrations + + Override in a subclass to manipulate the request or metadata + before they are sent to the PredictionApiKeyRegistry server. + """ + return request, metadata + + def post_list_prediction_api_key_registrations( + self, + response: prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse, + ) -> prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse: + """Post-rpc interceptor for list_prediction_api_key_registrations + + Override in a subclass to manipulate the response + after it is returned by the PredictionApiKeyRegistry server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class PredictionApiKeyRegistryRestStub: + _session: AuthorizedSession + _host: str + _interceptor: PredictionApiKeyRegistryRestInterceptor + + +class PredictionApiKeyRegistryRestTransport(PredictionApiKeyRegistryTransport): + """REST backend transport for PredictionApiKeyRegistry. + + Service for registering API keys for use with the ``predict`` + method. If you use an API key to request predictions, you must first + register the API key. Otherwise, your prediction request is + rejected. If you use OAuth to authenticate your ``predict`` method + call, you do not need to register an API key. You can register up to + 20 API keys per project. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via an issue in this + library's source repository. Thank you! + """ + + def __init__( + self, + *, + host: str = "recommendationengine.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[PredictionApiKeyRegistryRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via a GitHub issue in + this library's repository. Thank you! + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or PredictionApiKeyRegistryRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreatePredictionApiKeyRegistration(PredictionApiKeyRegistryRestStub): + def __hash__(self): + return hash("CreatePredictionApiKeyRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> prediction_apikey_registry_service.PredictionApiKeyRegistration: + r"""Call the create prediction api key + registration method over HTTP. + + Args: + request (~.prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest): + The request object. Request message for the + ``CreatePredictionApiKeyRegistration`` method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.prediction_apikey_registry_service.PredictionApiKeyRegistration: + Registered Api Key. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations", + "body": "*", + }, + ] + ( + request, + metadata, + ) = self._interceptor.pre_create_prediction_api_key_registration( + request, metadata + ) + pb_request = prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = prediction_apikey_registry_service.PredictionApiKeyRegistration() + pb_resp = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration.pb(resp) + ) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_prediction_api_key_registration(resp) + return resp + + class _DeletePredictionApiKeyRegistration(PredictionApiKeyRegistryRestStub): + def __hash__(self): + return hash("DeletePredictionApiKeyRegistration") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ): + r"""Call the delete prediction api key + registration method over HTTP. + + Args: + request (~.prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest): + The request object. Request message for + ``DeletePredictionApiKeyRegistration`` method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/predictionApiKeyRegistrations/*}", + }, + ] + ( + request, + metadata, + ) = self._interceptor.pre_delete_prediction_api_key_registration( + request, metadata + ) + pb_request = prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _ListPredictionApiKeyRegistrations(PredictionApiKeyRegistryRestStub): + def __hash__(self): + return hash("ListPredictionApiKeyRegistrations") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse: + r"""Call the list prediction api key + registrations method over HTTP. + + Args: + request (~.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest): + The request object. Request message for the + ``ListPredictionApiKeyRegistrations``. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse: + Response message for the + ``ListPredictionApiKeyRegistrations``. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations", + }, + ] + ( + request, + metadata, + ) = self._interceptor.pre_list_prediction_api_key_registrations( + request, metadata + ) + pb_request = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse() + ) + pb_resp = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.pb( + resp + ) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_prediction_api_key_registrations(resp) + return resp + + @property + def create_prediction_api_key_registration( + self, + ) -> Callable[ + [prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest], + prediction_apikey_registry_service.PredictionApiKeyRegistration, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreatePredictionApiKeyRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_prediction_api_key_registration( + self, + ) -> Callable[ + [prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest], + empty_pb2.Empty, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeletePredictionApiKeyRegistration(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_prediction_api_key_registrations( + self, + ) -> Callable[ + [prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest], + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListPredictionApiKeyRegistrations(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("PredictionApiKeyRegistryRestTransport",) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py index c674db797538..be5d2f6f084b 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/client.py @@ -40,6 +40,7 @@ from .transports.base import PredictionServiceTransport, DEFAULT_CLIENT_INFO from .transports.grpc import PredictionServiceGrpcTransport from .transports.grpc_asyncio import PredictionServiceGrpcAsyncIOTransport +from .transports.rest import PredictionServiceRestTransport class PredictionServiceClientMeta(type): @@ -55,6 +56,7 @@ class PredictionServiceClientMeta(type): ) # type: Dict[str, Type[PredictionServiceTransport]] _transport_registry["grpc"] = PredictionServiceGrpcTransport _transport_registry["grpc_asyncio"] = PredictionServiceGrpcAsyncIOTransport + _transport_registry["rest"] = PredictionServiceRestTransport def get_transport_class( cls, @@ -352,6 +354,9 @@ def __init__( transport (Union[str, PredictionServiceTransport]): The transport to use. If set to None, a transport is chosen automatically. + NOTE: "rest" transport functionality is currently in a + beta state (preview). We welcome your feedback via an + issue in this library's source repository. client_options (google.api_core.client_options.ClientOptions): Custom options for the client. It won't take effect if a ``transport`` instance is provided. (1) The ``api_endpoint`` property can be used to override the diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/__init__.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/__init__.py index 3b81984dc0b2..c3ca80df62e9 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/__init__.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/__init__.py @@ -19,15 +19,20 @@ from .base import PredictionServiceTransport from .grpc import PredictionServiceGrpcTransport from .grpc_asyncio import PredictionServiceGrpcAsyncIOTransport +from .rest import PredictionServiceRestTransport +from .rest import PredictionServiceRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[PredictionServiceTransport]] _transport_registry["grpc"] = PredictionServiceGrpcTransport _transport_registry["grpc_asyncio"] = PredictionServiceGrpcAsyncIOTransport +_transport_registry["rest"] = PredictionServiceRestTransport __all__ = ( "PredictionServiceTransport", "PredictionServiceGrpcTransport", "PredictionServiceGrpcAsyncIOTransport", + "PredictionServiceRestTransport", + "PredictionServiceRestInterceptor", ) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/rest.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/rest.py new file mode 100644 index 000000000000..c0cd5d7f5c8e --- /dev/null +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/prediction_service/transports/rest.py @@ -0,0 +1,323 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.cloud.recommendationengine_v1beta1.types import prediction_service + +from .base import ( + PredictionServiceTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class PredictionServiceRestInterceptor: + """Interceptor for PredictionService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the PredictionServiceRestTransport. + + .. code-block:: python + class MyCustomPredictionServiceInterceptor(PredictionServiceRestInterceptor): + def pre_predict(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_predict(response): + logging.log(f"Received response: {response}") + + transport = PredictionServiceRestTransport(interceptor=MyCustomPredictionServiceInterceptor()) + client = PredictionServiceClient(transport=transport) + + + """ + + def pre_predict( + self, + request: prediction_service.PredictRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[prediction_service.PredictRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for predict + + Override in a subclass to manipulate the request or metadata + before they are sent to the PredictionService server. + """ + return request, metadata + + def post_predict( + self, response: prediction_service.PredictResponse + ) -> prediction_service.PredictResponse: + """Post-rpc interceptor for predict + + Override in a subclass to manipulate the response + after it is returned by the PredictionService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class PredictionServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: PredictionServiceRestInterceptor + + +class PredictionServiceRestTransport(PredictionServiceTransport): + """REST backend transport for PredictionService. + + Service for making recommendation prediction. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via an issue in this + library's source repository. Thank you! + """ + + def __init__( + self, + *, + host: str = "recommendationengine.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[PredictionServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via a GitHub issue in + this library's repository. Thank you! + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or PredictionServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _Predict(PredictionServiceRestStub): + def __hash__(self): + return hash("Predict") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: prediction_service.PredictRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> prediction_service.PredictResponse: + r"""Call the predict method over HTTP. + + Args: + request (~.prediction_service.PredictRequest): + The request object. Request message for Predict method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.prediction_service.PredictResponse: + Response message for predict method. + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/placements/*}:predict", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_predict(request, metadata) + pb_request = prediction_service.PredictRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = prediction_service.PredictResponse() + pb_resp = prediction_service.PredictResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_predict(resp) + return resp + + @property + def predict( + self, + ) -> Callable[ + [prediction_service.PredictRequest], prediction_service.PredictResponse + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._Predict(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("PredictionServiceRestTransport",) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py index 80a630487453..0ecebf179252 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/client.py @@ -47,6 +47,7 @@ from .transports.base import UserEventServiceTransport, DEFAULT_CLIENT_INFO from .transports.grpc import UserEventServiceGrpcTransport from .transports.grpc_asyncio import UserEventServiceGrpcAsyncIOTransport +from .transports.rest import UserEventServiceRestTransport class UserEventServiceClientMeta(type): @@ -62,6 +63,7 @@ class UserEventServiceClientMeta(type): ) # type: Dict[str, Type[UserEventServiceTransport]] _transport_registry["grpc"] = UserEventServiceGrpcTransport _transport_registry["grpc_asyncio"] = UserEventServiceGrpcAsyncIOTransport + _transport_registry["rest"] = UserEventServiceRestTransport def get_transport_class( cls, @@ -359,6 +361,9 @@ def __init__( transport (Union[str, UserEventServiceTransport]): The transport to use. If set to None, a transport is chosen automatically. + NOTE: "rest" transport functionality is currently in a + beta state (preview). We welcome your feedback via an + issue in this library's source repository. client_options (google.api_core.client_options.ClientOptions): Custom options for the client. It won't take effect if a ``transport`` instance is provided. (1) The ``api_endpoint`` property can be used to override the diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/__init__.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/__init__.py index a64577a7d8be..8c380cb0211a 100644 --- a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/__init__.py +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/__init__.py @@ -19,15 +19,20 @@ from .base import UserEventServiceTransport from .grpc import UserEventServiceGrpcTransport from .grpc_asyncio import UserEventServiceGrpcAsyncIOTransport +from .rest import UserEventServiceRestTransport +from .rest import UserEventServiceRestInterceptor # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[UserEventServiceTransport]] _transport_registry["grpc"] = UserEventServiceGrpcTransport _transport_registry["grpc_asyncio"] = UserEventServiceGrpcAsyncIOTransport +_transport_registry["rest"] = UserEventServiceRestTransport __all__ = ( "UserEventServiceTransport", "UserEventServiceGrpcTransport", "UserEventServiceGrpcAsyncIOTransport", + "UserEventServiceRestTransport", + "UserEventServiceRestInterceptor", ) diff --git a/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/rest.py b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/rest.py new file mode 100644 index 000000000000..8e9bd62f2bf5 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/google/cloud/recommendationengine_v1beta1/services/user_event_service/transports/rest.py @@ -0,0 +1,944 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from google.api_core import operations_v1 +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + + +from google.api import httpbody_pb2 # type: ignore +from google.cloud.recommendationengine_v1beta1.types import import_ +from google.cloud.recommendationengine_v1beta1.types import user_event as gcr_user_event +from google.cloud.recommendationengine_v1beta1.types import user_event_service +from google.longrunning import operations_pb2 # type: ignore + +from .base import ( + UserEventServiceTransport, + DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO, +) + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class UserEventServiceRestInterceptor: + """Interceptor for UserEventService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the UserEventServiceRestTransport. + + .. code-block:: python + class MyCustomUserEventServiceInterceptor(UserEventServiceRestInterceptor): + def pre_collect_user_event(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_collect_user_event(response): + logging.log(f"Received response: {response}") + + def pre_import_user_events(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_user_events(response): + logging.log(f"Received response: {response}") + + def pre_list_user_events(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_user_events(response): + logging.log(f"Received response: {response}") + + def pre_purge_user_events(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_purge_user_events(response): + logging.log(f"Received response: {response}") + + def pre_write_user_event(request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_write_user_event(response): + logging.log(f"Received response: {response}") + + transport = UserEventServiceRestTransport(interceptor=MyCustomUserEventServiceInterceptor()) + client = UserEventServiceClient(transport=transport) + + + """ + + def pre_collect_user_event( + self, + request: user_event_service.CollectUserEventRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[user_event_service.CollectUserEventRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for collect_user_event + + Override in a subclass to manipulate the request or metadata + before they are sent to the UserEventService server. + """ + return request, metadata + + def post_collect_user_event( + self, response: httpbody_pb2.HttpBody + ) -> httpbody_pb2.HttpBody: + """Post-rpc interceptor for collect_user_event + + Override in a subclass to manipulate the response + after it is returned by the UserEventService server but before + it is returned to user code. + """ + return response + + def pre_import_user_events( + self, + request: import_.ImportUserEventsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[import_.ImportUserEventsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for import_user_events + + Override in a subclass to manipulate the request or metadata + before they are sent to the UserEventService server. + """ + return request, metadata + + def post_import_user_events( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for import_user_events + + Override in a subclass to manipulate the response + after it is returned by the UserEventService server but before + it is returned to user code. + """ + return response + + def pre_list_user_events( + self, + request: user_event_service.ListUserEventsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[user_event_service.ListUserEventsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_user_events + + Override in a subclass to manipulate the request or metadata + before they are sent to the UserEventService server. + """ + return request, metadata + + def post_list_user_events( + self, response: user_event_service.ListUserEventsResponse + ) -> user_event_service.ListUserEventsResponse: + """Post-rpc interceptor for list_user_events + + Override in a subclass to manipulate the response + after it is returned by the UserEventService server but before + it is returned to user code. + """ + return response + + def pre_purge_user_events( + self, + request: user_event_service.PurgeUserEventsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[user_event_service.PurgeUserEventsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for purge_user_events + + Override in a subclass to manipulate the request or metadata + before they are sent to the UserEventService server. + """ + return request, metadata + + def post_purge_user_events( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for purge_user_events + + Override in a subclass to manipulate the response + after it is returned by the UserEventService server but before + it is returned to user code. + """ + return response + + def pre_write_user_event( + self, + request: user_event_service.WriteUserEventRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[user_event_service.WriteUserEventRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for write_user_event + + Override in a subclass to manipulate the request or metadata + before they are sent to the UserEventService server. + """ + return request, metadata + + def post_write_user_event( + self, response: gcr_user_event.UserEvent + ) -> gcr_user_event.UserEvent: + """Post-rpc interceptor for write_user_event + + Override in a subclass to manipulate the response + after it is returned by the UserEventService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class UserEventServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: UserEventServiceRestInterceptor + + +class UserEventServiceRestTransport(UserEventServiceTransport): + """REST backend transport for UserEventService. + + Service for ingesting end user actions on the customer + website. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via an issue in this + library's source repository. Thank you! + """ + + def __init__( + self, + *, + host: str = "recommendationengine.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[UserEventServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + NOTE: This REST transport functionality is currently in a beta + state (preview). We welcome your feedback via a GitHub issue in + this library's repository. Thank you! + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or UserEventServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + @property + def operations_client(self) -> operations_v1.AbstractOperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Only create a new client if we do not already have one. + if self._operations_client is None: + http_options: Dict[str, List[Dict[str, str]]] = {} + + rest_transport = operations_v1.OperationsRestTransport( + host=self._host, + # use the credentials which are saved + credentials=self._credentials, + scopes=self._scopes, + http_options=http_options, + ) + + self._operations_client = operations_v1.AbstractOperationsClient( + transport=rest_transport + ) + + # Return the client from cache. + return self._operations_client + + class _CollectUserEvent(UserEventServiceRestStub): + def __hash__(self): + return hash("CollectUserEvent") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "userEvent": "", + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: user_event_service.CollectUserEventRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> httpbody_pb2.HttpBody: + r"""Call the collect user event method over HTTP. + + Args: + request (~.user_event_service.CollectUserEventRequest): + The request object. Request message for CollectUserEvent + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.httpbody_pb2.HttpBody: + Message that represents an arbitrary HTTP body. It + should only be used for payload formats that can't be + represented as JSON, such as raw binary or an HTML page. + + This message can be used both in streaming and + non-streaming API methods in the request as well as the + response. + + It can be used as a top-level request field, which is + convenient if one wants to extract parameters from + either the URL or HTTP template into the request fields + and also want access to the raw HTTP body. + + Example: + + :: + + message GetResourceRequest { + // A unique request id. + string request_id = 1; + + // The raw HTTP body is bound to this field. + google.api.HttpBody http_body = 2; + + } + + service ResourceService { + rpc GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); + + } + + Example with streaming methods: + + :: + + service CaldavService { + rpc GetCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); + rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); + + } + + Use of this type only changes how the request and + response bodies are handled, all other features will + continue to work unchanged. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:collect", + }, + ] + request, metadata = self._interceptor.pre_collect_user_event( + request, metadata + ) + pb_request = user_event_service.CollectUserEventRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = httpbody_pb2.HttpBody() + pb_resp = resp + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_collect_user_event(resp) + return resp + + class _ImportUserEvents(UserEventServiceRestStub): + def __hash__(self): + return hash("ImportUserEvents") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: import_.ImportUserEventsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the import user events method over HTTP. + + Args: + request (~.import_.ImportUserEventsRequest): + The request object. Request message for the + ImportUserEvents request. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:import", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_import_user_events( + request, metadata + ) + pb_request = import_.ImportUserEventsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_user_events(resp) + return resp + + class _ListUserEvents(UserEventServiceRestStub): + def __hash__(self): + return hash("ListUserEvents") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: user_event_service.ListUserEventsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> user_event_service.ListUserEventsResponse: + r"""Call the list user events method over HTTP. + + Args: + request (~.user_event_service.ListUserEventsRequest): + The request object. Request message for ListUserEvents + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.user_event_service.ListUserEventsResponse: + Response message for ListUserEvents + method. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents", + }, + ] + request, metadata = self._interceptor.pre_list_user_events( + request, metadata + ) + pb_request = user_event_service.ListUserEventsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = user_event_service.ListUserEventsResponse() + pb_resp = user_event_service.ListUserEventsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_user_events(resp) + return resp + + class _PurgeUserEvents(UserEventServiceRestStub): + def __hash__(self): + return hash("PurgeUserEvents") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: user_event_service.PurgeUserEventsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Call the purge user events method over HTTP. + + Args: + request (~.user_event_service.PurgeUserEventsRequest): + The request object. Request message for PurgeUserEvents + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.operations_pb2.Operation: + This resource represents a + long-running operation that is the + result of a network API call. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:purge", + "body": "*", + }, + ] + request, metadata = self._interceptor.pre_purge_user_events( + request, metadata + ) + pb_request = user_event_service.PurgeUserEventsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = operations_pb2.Operation() + json_format.Parse(response.content, resp, ignore_unknown_fields=True) + resp = self._interceptor.post_purge_user_events(resp) + return resp + + class _WriteUserEvent(UserEventServiceRestStub): + def __hash__(self): + return hash("WriteUserEvent") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: user_event_service.WriteUserEventRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> gcr_user_event.UserEvent: + r"""Call the write user event method over HTTP. + + Args: + request (~.user_event_service.WriteUserEventRequest): + The request object. Request message for WriteUserEvent + method. + + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + ~.gcr_user_event.UserEvent: + UserEvent captures all metadata + information recommendation engine needs + to know about how end users interact + with customers' website. + + """ + + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:write", + "body": "user_event", + }, + ] + request, metadata = self._interceptor.pre_write_user_event( + request, metadata + ) + pb_request = user_event_service.WriteUserEventRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + uri = transcoded_request["uri"] + method = transcoded_request["method"] + + # Jsonify the query params + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + query_params.update(self._get_unset_required_fields(query_params)) + + # Send the request + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = gcr_user_event.UserEvent() + pb_resp = gcr_user_event.UserEvent.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_write_user_event(resp) + return resp + + @property + def collect_user_event( + self, + ) -> Callable[[user_event_service.CollectUserEventRequest], httpbody_pb2.HttpBody]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CollectUserEvent(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_user_events( + self, + ) -> Callable[[import_.ImportUserEventsRequest], operations_pb2.Operation]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ImportUserEvents(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_user_events( + self, + ) -> Callable[ + [user_event_service.ListUserEventsRequest], + user_event_service.ListUserEventsResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListUserEvents(self._session, self._host, self._interceptor) # type: ignore + + @property + def purge_user_events( + self, + ) -> Callable[ + [user_event_service.PurgeUserEventsRequest], operations_pb2.Operation + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._PurgeUserEvents(self._session, self._host, self._interceptor) # type: ignore + + @property + def write_user_event( + self, + ) -> Callable[[user_event_service.WriteUserEventRequest], gcr_user_event.UserEvent]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._WriteUserEvent(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("UserEventServiceRestTransport",) diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py new file mode 100644 index 000000000000..8707540ce8ed --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync_b388a984] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_create_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + catalog_item = recommendationengine_v1beta1.CatalogItem() + catalog_item.id = "id_value" + catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2'] + catalog_item.title = "title_value" + + request = recommendationengine_v1beta1.CreateCatalogItemRequest( + parent="parent_value", + catalog_item=catalog_item, + ) + + # Make the request + response = client.create_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync_b388a984] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py new file mode 100644 index 000000000000..d76dd060e7eb --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync_d75dfd44] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_create_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + catalog_item = recommendationengine_v1beta1.CatalogItem() + catalog_item.id = "id_value" + catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2'] + catalog_item.title = "title_value" + + request = recommendationengine_v1beta1.CreateCatalogItemRequest( + parent="parent_value", + catalog_item=catalog_item, + ) + + # Make the request + response = client.create_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync_d75dfd44] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py new file mode 100644 index 000000000000..2321ce446553 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync_66bf5928] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_delete_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.DeleteCatalogItemRequest( + name="name_value", + ) + + # Make the request + client.delete_catalog_item(request=request) + + +# [END recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync_66bf5928] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py new file mode 100644 index 000000000000..24bb8cd47584 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync_8be644dc] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_delete_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.DeleteCatalogItemRequest( + name="name_value", + ) + + # Make the request + client.delete_catalog_item(request=request) + + +# [END recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync_8be644dc] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py new file mode 100644 index 000000000000..3b9ddae26420 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync_4ea33c38] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_get_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.GetCatalogItemRequest( + name="name_value", + ) + + # Make the request + response = client.get_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync_4ea33c38] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py new file mode 100644 index 000000000000..9b5722d2bf51 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync_7d3f85d9] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_get_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.GetCatalogItemRequest( + name="name_value", + ) + + # Make the request + response = client.get_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync_7d3f85d9] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py new file mode 100644 index 000000000000..aaef3c62af50 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ImportCatalogItems +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync_d3c3edf0] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_import_catalog_items(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ImportCatalogItemsRequest( + parent="parent_value", + ) + + # Make the request + operation = client.import_catalog_items(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync_d3c3edf0] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py new file mode 100644 index 000000000000..df6ce7d1650b --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ImportCatalogItems +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync_e3f144cd] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_import_catalog_items(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ImportCatalogItemsRequest( + parent="parent_value", + ) + + # Make the request + operation = client.import_catalog_items(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync_e3f144cd] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py new file mode 100644 index 000000000000..12056780f0aa --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCatalogItems +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync_2bf256a9] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_catalog_items(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListCatalogItemsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_catalog_items(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync_2bf256a9] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py new file mode 100644 index 000000000000..98000bec2f5f --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCatalogItems +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync_a2793df4] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_catalog_items(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListCatalogItemsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_catalog_items(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync_a2793df4] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py new file mode 100644 index 000000000000..05a8f2b6d2c6 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync_266ee256] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_update_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + catalog_item = recommendationengine_v1beta1.CatalogItem() + catalog_item.id = "id_value" + catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2'] + catalog_item.title = "title_value" + + request = recommendationengine_v1beta1.UpdateCatalogItemRequest( + name="name_value", + catalog_item=catalog_item, + ) + + # Make the request + response = client.update_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync_266ee256] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py new file mode 100644 index 000000000000..61ee23b3f1ce --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCatalogItem +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync_abe0821d] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_update_catalog_item(): + # Create a client + client = recommendationengine_v1beta1.CatalogServiceClient() + + # Initialize request argument(s) + catalog_item = recommendationengine_v1beta1.CatalogItem() + catalog_item.id = "id_value" + catalog_item.category_hierarchies.categories = ['categories_value1', 'categories_value2'] + catalog_item.title = "title_value" + + request = recommendationengine_v1beta1.UpdateCatalogItemRequest( + name="name_value", + catalog_item=catalog_item, + ) + + # Make the request + response = client.update_catalog_item(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync_abe0821d] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py new file mode 100644 index 000000000000..d5f24484b7d9 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePredictionApiKeyRegistration +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync_8ddf5d36] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_create_prediction_api_key_registration(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.CreatePredictionApiKeyRegistrationRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_prediction_api_key_registration(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync_8ddf5d36] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py new file mode 100644 index 000000000000..114bbfc61435 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePredictionApiKeyRegistration +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync_c078ad83] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_create_prediction_api_key_registration(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.CreatePredictionApiKeyRegistrationRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_prediction_api_key_registration(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync_c078ad83] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py new file mode 100644 index 000000000000..2e74fee424cd --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePredictionApiKeyRegistration +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync_3de55013] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_delete_prediction_api_key_registration(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.DeletePredictionApiKeyRegistrationRequest( + name="name_value", + ) + + # Make the request + client.delete_prediction_api_key_registration(request=request) + + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync_3de55013] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py new file mode 100644 index 000000000000..363beafae937 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePredictionApiKeyRegistration +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync_f40a4844] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_delete_prediction_api_key_registration(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.DeletePredictionApiKeyRegistrationRequest( + name="name_value", + ) + + # Make the request + client.delete_prediction_api_key_registration(request=request) + + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync_f40a4844] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py new file mode 100644 index 000000000000..8d9a4f306079 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPredictionApiKeyRegistrations +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync_2d26cba1] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_prediction_api_key_registrations(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListPredictionApiKeyRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_prediction_api_key_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync_2d26cba1] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py new file mode 100644 index 000000000000..0f37de8e6206 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPredictionApiKeyRegistrations +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync_4cdac270] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_prediction_api_key_registrations(): + # Create a client + client = recommendationengine_v1beta1.PredictionApiKeyRegistryClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListPredictionApiKeyRegistrationsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_prediction_api_key_registrations(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync_4cdac270] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py new file mode 100644 index 000000000000..633e5596e838 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Predict +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionService_Predict_sync_31326670] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_predict(): + # Create a client + client = recommendationengine_v1beta1.PredictionServiceClient() + + # Initialize request argument(s) + user_event = recommendationengine_v1beta1.UserEvent() + user_event.event_type = "event_type_value" + user_event.user_info.visitor_id = "visitor_id_value" + + request = recommendationengine_v1beta1.PredictRequest( + name="name_value", + user_event=user_event, + ) + + # Make the request + page_result = client.predict(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionService_Predict_sync_31326670] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py new file mode 100644 index 000000000000..fab5f6227e9b --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Predict +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_PredictionService_Predict_sync_a38ea195] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_predict(): + # Create a client + client = recommendationengine_v1beta1.PredictionServiceClient() + + # Initialize request argument(s) + user_event = recommendationengine_v1beta1.UserEvent() + user_event.event_type = "event_type_value" + user_event.user_info.visitor_id = "visitor_id_value" + + request = recommendationengine_v1beta1.PredictRequest( + name="name_value", + user_event=user_event, + ) + + # Make the request + page_result = client.predict(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_PredictionService_Predict_sync_a38ea195] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py new file mode 100644 index 000000000000..80dc3ebbfef6 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CollectUserEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync_9128505b] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_collect_user_event(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.CollectUserEventRequest( + parent="parent_value", + user_event="user_event_value", + ) + + # Make the request + response = client.collect_user_event(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync_9128505b] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py new file mode 100644 index 000000000000..9dafd8ed974d --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CollectUserEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync_beed3ba7] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_collect_user_event(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.CollectUserEventRequest( + parent="parent_value", + user_event="user_event_value", + ) + + # Make the request + response = client.collect_user_event(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync_beed3ba7] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py new file mode 100644 index 000000000000..91dbac19d0ad --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ImportUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync_1b260921] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_import_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ImportUserEventsRequest( + parent="parent_value", + ) + + # Make the request + operation = client.import_user_events(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync_1b260921] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py new file mode 100644 index 000000000000..12f9276fd621 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ImportUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync_202fd725] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_import_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ImportUserEventsRequest( + parent="parent_value", + ) + + # Make the request + operation = client.import_user_events(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync_202fd725] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py new file mode 100644 index 000000000000..570e12544396 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync_ccefa7ab] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListUserEventsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_user_events(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync_ccefa7ab] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py new file mode 100644 index 000000000000..34a59b12060d --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync_d6baec98] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_list_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.ListUserEventsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_user_events(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync_d6baec98] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py new file mode 100644 index 000000000000..0ef26b565648 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for PurgeUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync_37388c66] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_purge_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.PurgeUserEventsRequest( + parent="parent_value", + filter="filter_value", + ) + + # Make the request + operation = client.purge_user_events(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync_37388c66] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py new file mode 100644 index 000000000000..ec3a010efa20 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for PurgeUserEvents +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync_bd0d439c] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_purge_user_events(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + request = recommendationengine_v1beta1.PurgeUserEventsRequest( + parent="parent_value", + filter="filter_value", + ) + + # Make the request + operation = client.purge_user_events(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync_bd0d439c] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py new file mode 100644 index 000000000000..cc8a19ab5105 --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for WriteUserEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync_62b9e427] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_write_user_event(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + user_event = recommendationengine_v1beta1.UserEvent() + user_event.event_type = "event_type_value" + user_event.user_info.visitor_id = "visitor_id_value" + + request = recommendationengine_v1beta1.WriteUserEventRequest( + parent="parent_value", + user_event=user_event, + ) + + # Make the request + response = client.write_user_event(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync_62b9e427] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py new file mode 100644 index 000000000000..4a71339c6ede --- /dev/null +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for WriteUserEvent +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-recommendations-ai + + +# [START recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync_b58371f7] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import recommendationengine_v1beta1 + + +def sample_write_user_event(): + # Create a client + client = recommendationengine_v1beta1.UserEventServiceClient() + + # Initialize request argument(s) + user_event = recommendationengine_v1beta1.UserEvent() + user_event.event_type = "event_type_value" + user_event.user_info.visitor_id = "visitor_id_value" + + request = recommendationengine_v1beta1.WriteUserEventRequest( + parent="parent_value", + user_event=user_event, + ) + + # Make the request + response = client.write_user_event(request=request) + + # Handle the response + print(response) + +# [END recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync_b58371f7] diff --git a/packages/google-cloud-recommendations-ai/samples/generated_samples/snippet_metadata_recommendationengine_v1beta1.json b/packages/google-cloud-recommendations-ai/samples/generated_samples/snippet_metadata_recommendationengine_v1beta1.json index 3866b294fa2d..310a9f791f31 100644 --- a/packages/google-cloud-recommendations-ai/samples/generated_samples/snippet_metadata_recommendationengine_v1beta1.json +++ b/packages/google-cloud-recommendations-ai/samples/generated_samples/snippet_metadata_recommendationengine_v1beta1.json @@ -141,7 +141,7 @@ "shortName": "create_catalog_item" }, "description": "Sample for CreateCatalogItem", - "file": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync.py", + "file": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync", @@ -177,7 +177,91 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_d75dfd44.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.create_catalog_item", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.CreateCatalogItem", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" + }, + "shortName": "CreateCatalogItem" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.CreateCatalogItemRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "catalog_item", + "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", + "shortName": "create_catalog_item" + }, + "description": "Sample for CreateCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_CreateCatalogItem_sync", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 51, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 54, + "start": 52, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 55, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_catalog_service_create_catalog_item_sync_b388a984.py" }, { "canonical": true, @@ -298,7 +382,84 @@ "shortName": "delete_catalog_item" }, "description": "Sample for DeleteCatalogItem", - "file": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync.py", + "file": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_66bf5928.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.delete_catalog_item", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.DeleteCatalogItem", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" + }, + "shortName": "DeleteCatalogItem" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.DeleteCatalogItemRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_catalog_item" + }, + "description": "Sample for DeleteCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_CatalogService_DeleteCatalogItem_sync", @@ -332,7 +493,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_delete_catalog_item_sync_8be644dc.py" }, { "canonical": true, @@ -457,7 +618,7 @@ "shortName": "get_catalog_item" }, "description": "Sample for GetCatalogItem", - "file": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync.py", + "file": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync", @@ -493,46 +654,33 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_7d3f85d9.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient", - "shortName": "CatalogServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.import_catalog_items", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.get_catalog_item", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ImportCatalogItems", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.GetCatalogItem", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", "shortName": "CatalogService" }, - "shortName": "ImportCatalogItems" + "shortName": "GetCatalogItem" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest" - }, - { - "name": "parent", - "type": "str" + "type": "google.cloud.recommendationengine_v1beta1.types.GetCatalogItemRequest" }, { - "name": "request_id", + "name": "name", "type": "str" }, - { - "name": "input_config", - "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" - }, - { - "name": "errors_config", - "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" - }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -546,22 +694,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "import_catalog_items" + "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", + "shortName": "get_catalog_item" }, - "description": "Sample for ImportCatalogItems", - "file": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_async.py", + "description": "Sample for GetCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_async", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_GetCatalogItem_sync", "segments": [ { - "end": 55, + "end": 51, "start": 27, "type": "FULL" }, { - "end": 55, + "end": 51, "start": 27, "type": "SHORT" }, @@ -576,26 +724,27 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 52, + "end": 48, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 56, - "start": 53, + "end": 52, + "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_async.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_get_catalog_item_sync_4ea33c38.py" }, { "canonical": true, "clientMethod": { + "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", - "shortName": "CatalogServiceClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient", + "shortName": "CatalogServiceAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.import_catalog_items", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.import_catalog_items", "method": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ImportCatalogItems", "service": { @@ -638,14 +787,14 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.api_core.operation.Operation", + "resultType": "google.api_core.operation_async.AsyncOperation", "shortName": "import_catalog_items" }, "description": "Sample for ImportCatalogItems", - "file": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync.py", + "file": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_async", "segments": [ { "end": 55, @@ -678,38 +827,45 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_async.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient", - "shortName": "CatalogServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.list_catalog_items", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.import_catalog_items", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ListCatalogItems", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ImportCatalogItems", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", "shortName": "CatalogService" }, - "shortName": "ListCatalogItems" + "shortName": "ImportCatalogItems" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest" }, { "name": "parent", "type": "str" }, { - "name": "filter", + "name": "request_id", "type": "str" }, + { + "name": "input_config", + "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" + }, + { + "name": "errors_config", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -723,22 +879,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager", - "shortName": "list_catalog_items" + "resultType": "google.api_core.operation.Operation", + "shortName": "import_catalog_items" }, - "description": "Sample for ListCatalogItems", - "file": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_async.py", + "description": "Sample for ImportCatalogItems", + "file": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_async", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync", "segments": [ { - "end": 52, + "end": 55, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 55, "start": 27, "type": "SHORT" }, @@ -753,17 +909,17 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 48, + "end": 52, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 53, - "start": 49, + "end": 56, + "start": 53, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_async.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_d3c3edf0.py" }, { "canonical": true, @@ -772,28 +928,36 @@ "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.list_catalog_items", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.import_catalog_items", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ListCatalogItems", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ImportCatalogItems", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", "shortName": "CatalogService" }, - "shortName": "ListCatalogItems" + "shortName": "ImportCatalogItems" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest" }, { "name": "parent", "type": "str" }, { - "name": "filter", + "name": "request_id", "type": "str" }, + { + "name": "input_config", + "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" + }, + { + "name": "errors_config", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -807,22 +971,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager", - "shortName": "list_catalog_items" + "resultType": "google.api_core.operation.Operation", + "shortName": "import_catalog_items" }, - "description": "Sample for ListCatalogItems", - "file": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync.py", + "description": "Sample for ImportCatalogItems", + "file": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ImportCatalogItems_sync", "segments": [ { - "end": 52, + "end": 55, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 55, "start": 27, "type": "SHORT" }, @@ -837,17 +1001,17 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 48, + "end": 52, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 53, - "start": 49, + "end": 56, + "start": 53, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_import_catalog_items_sync_e3f144cd.py" }, { "canonical": true, @@ -857,31 +1021,27 @@ "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient", "shortName": "CatalogServiceAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.update_catalog_item", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.list_catalog_items", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.UpdateCatalogItem", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ListCatalogItems", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", "shortName": "CatalogService" }, - "shortName": "UpdateCatalogItem" + "shortName": "ListCatalogItems" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest" }, { - "name": "name", + "name": "parent", "type": "str" }, { - "name": "catalog_item", - "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" + "name": "filter", + "type": "str" }, { "name": "retry", @@ -896,22 +1056,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", - "shortName": "update_catalog_item" + "resultType": "google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager", + "shortName": "list_catalog_items" }, - "description": "Sample for UpdateCatalogItem", - "file": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_async.py", + "description": "Sample for ListCatalogItems", + "file": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_async", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_async", "segments": [ { - "end": 57, + "end": 52, "start": 27, "type": "FULL" }, { - "end": 57, + "end": 52, "start": 27, "type": "SHORT" }, @@ -921,22 +1081,22 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 51, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 54, - "start": 52, + "end": 48, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 58, - "start": 55, + "end": 53, + "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_async.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_async.py" }, { "canonical": true, @@ -945,31 +1105,27 @@ "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.update_catalog_item", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.list_catalog_items", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.UpdateCatalogItem", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ListCatalogItems", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", "shortName": "CatalogService" }, - "shortName": "UpdateCatalogItem" + "shortName": "ListCatalogItems" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest" }, { - "name": "name", + "name": "parent", "type": "str" }, { - "name": "catalog_item", - "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" + "name": "filter", + "type": "str" }, { "name": "retry", @@ -984,22 +1140,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", - "shortName": "update_catalog_item" + "resultType": "google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager", + "shortName": "list_catalog_items" }, - "description": "Sample for UpdateCatalogItem", - "file": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync.py", + "description": "Sample for ListCatalogItems", + "file": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync", "segments": [ { - "end": 57, + "end": 52, "start": 27, "type": "FULL" }, { - "end": 57, + "end": 52, "start": 27, "type": "SHORT" }, @@ -1009,52 +1165,51 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 51, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 54, - "start": 52, + "end": 48, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 58, - "start": 55, + "end": 53, + "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_a2793df4.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient", - "shortName": "PredictionApiKeyRegistryAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.create_prediction_api_key_registration", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.list_catalog_items", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.CreatePredictionApiKeyRegistration", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.ListCatalogItems", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", - "shortName": "PredictionApiKeyRegistry" + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" }, - "shortName": "CreatePredictionApiKeyRegistration" + "shortName": "ListCatalogItems" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest" }, { "name": "parent", "type": "str" }, { - "name": "prediction_api_key_registration", - "type": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration" + "name": "filter", + "type": "str" }, { "name": "retry", @@ -1069,22 +1224,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration", - "shortName": "create_prediction_api_key_registration" + "resultType": "google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager", + "shortName": "list_catalog_items" }, - "description": "Sample for CreatePredictionApiKeyRegistration", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_async.py", + "description": "Sample for ListCatalogItems", + "file": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_async", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_ListCatalogItems_sync", "segments": [ { - "end": 51, + "end": 52, "start": 27, "type": "FULL" }, { - "end": 51, + "end": 52, "start": 27, "type": "SHORT" }, @@ -1104,41 +1259,46 @@ "type": "REQUEST_EXECUTION" }, { - "end": 52, + "end": 53, "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_async.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_list_catalog_items_sync_2bf256a9.py" }, { "canonical": true, "clientMethod": { + "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", - "shortName": "PredictionApiKeyRegistryClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient", + "shortName": "CatalogServiceAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.create_prediction_api_key_registration", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceAsyncClient.update_catalog_item", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.CreatePredictionApiKeyRegistration", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.UpdateCatalogItem", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", - "shortName": "PredictionApiKeyRegistry" + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" }, - "shortName": "CreatePredictionApiKeyRegistration" + "shortName": "UpdateCatalogItem" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest" }, { - "name": "parent", + "name": "name", "type": "str" }, { - "name": "prediction_api_key_registration", - "type": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration" + "name": "catalog_item", + "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" }, { "name": "retry", @@ -1153,22 +1313,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration", - "shortName": "create_prediction_api_key_registration" + "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", + "shortName": "update_catalog_item" }, - "description": "Sample for CreatePredictionApiKeyRegistration", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync.py", + "description": "Sample for UpdateCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_async", "segments": [ { - "end": 51, + "end": 57, "start": 27, "type": "FULL" }, { - "end": 51, + "end": 57, "start": 27, "type": "SHORT" }, @@ -1178,49 +1338,56 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 45, + "end": 51, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 48, - "start": 46, + "end": 54, + "start": 52, "type": "REQUEST_EXECUTION" }, { - "end": 52, - "start": 49, + "end": 58, + "start": 55, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_async.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient", - "shortName": "PredictionApiKeyRegistryAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.delete_prediction_api_key_registration", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.update_catalog_item", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.DeletePredictionApiKeyRegistration", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.UpdateCatalogItem", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", - "shortName": "PredictionApiKeyRegistry" + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" }, - "shortName": "DeletePredictionApiKeyRegistration" + "shortName": "UpdateCatalogItem" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest" }, { "name": "name", "type": "str" }, + { + "name": "catalog_item", + "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1234,21 +1401,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "shortName": "delete_prediction_api_key_registration" + "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", + "shortName": "update_catalog_item" }, - "description": "Sample for DeletePredictionApiKeyRegistration", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_async.py", + "description": "Sample for UpdateCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_async", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync", "segments": [ { - "end": 49, + "end": 57, "start": 27, "type": "FULL" }, { - "end": 49, + "end": 57, "start": 27, "type": "SHORT" }, @@ -1258,46 +1426,56 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 45, + "end": 51, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "start": 46, + "end": 54, + "start": 52, "type": "REQUEST_EXECUTION" }, { - "end": 50, - "type": "RESPONSE_HANDLING" + "end": 58, + "start": 55, + "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_async.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_266ee256.py" }, { "canonical": true, "clientMethod": { "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", - "shortName": "PredictionApiKeyRegistryClient" + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient", + "shortName": "CatalogServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.delete_prediction_api_key_registration", + "fullName": "google.cloud.recommendationengine_v1beta1.CatalogServiceClient.update_catalog_item", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.DeletePredictionApiKeyRegistration", + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService.UpdateCatalogItem", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", - "shortName": "PredictionApiKeyRegistry" + "fullName": "google.cloud.recommendationengine.v1beta1.CatalogService", + "shortName": "CatalogService" }, - "shortName": "DeletePredictionApiKeyRegistration" + "shortName": "UpdateCatalogItem" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest" }, { "name": "name", "type": "str" }, + { + "name": "catalog_item", + "type": "google.cloud.recommendationengine_v1beta1.types.CatalogItem" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1311,21 +1489,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "shortName": "delete_prediction_api_key_registration" + "resultType": "google.cloud.recommendationengine_v1beta1.types.CatalogItem", + "shortName": "update_catalog_item" }, - "description": "Sample for DeletePredictionApiKeyRegistration", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync.py", + "description": "Sample for UpdateCatalogItem", + "file": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync", + "regionTag": "recommendationengine_v1beta1_generated_CatalogService_UpdateCatalogItem_sync", "segments": [ { - "end": 49, + "end": 57, "start": 27, "type": "FULL" }, { - "end": 49, + "end": 57, "start": 27, "type": "SHORT" }, @@ -1335,20 +1514,22 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 45, + "end": 51, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "start": 46, + "end": 54, + "start": 52, "type": "REQUEST_EXECUTION" }, { - "end": 50, + "end": 58, + "start": 55, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync.py" + "title": "recommendationengine_v1beta1_generated_catalog_service_update_catalog_item_sync_abe0821d.py" }, { "canonical": true, @@ -1358,24 +1539,28 @@ "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient", "shortName": "PredictionApiKeyRegistryAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.list_prediction_api_key_registrations", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.create_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.ListPredictionApiKeyRegistrations", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.CreatePredictionApiKeyRegistration", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", "shortName": "PredictionApiKeyRegistry" }, - "shortName": "ListPredictionApiKeyRegistrations" + "shortName": "CreatePredictionApiKeyRegistration" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest" }, { "name": "parent", "type": "str" }, + { + "name": "prediction_api_key_registration", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1389,22 +1574,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager", - "shortName": "list_prediction_api_key_registrations" + "resultType": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration", + "shortName": "create_prediction_api_key_registration" }, - "description": "Sample for ListPredictionApiKeyRegistrations", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_async.py", + "description": "Sample for CreatePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_async", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_async", "segments": [ { - "end": 52, + "end": 51, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 51, "start": 27, "type": "SHORT" }, @@ -1424,12 +1609,12 @@ "type": "REQUEST_EXECUTION" }, { - "end": 53, + "end": 52, "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_async.py" + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_async.py" }, { "canonical": true, @@ -1438,24 +1623,28 @@ "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", "shortName": "PredictionApiKeyRegistryClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.list_prediction_api_key_registrations", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.create_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.ListPredictionApiKeyRegistrations", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.CreatePredictionApiKeyRegistration", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", "shortName": "PredictionApiKeyRegistry" }, - "shortName": "ListPredictionApiKeyRegistrations" + "shortName": "CreatePredictionApiKeyRegistration" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest" }, { "name": "parent", "type": "str" }, + { + "name": "prediction_api_key_registration", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration" + }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1469,22 +1658,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager", - "shortName": "list_prediction_api_key_registrations" + "resultType": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration", + "shortName": "create_prediction_api_key_registration" }, - "description": "Sample for ListPredictionApiKeyRegistrations", - "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync.py", + "description": "Sample for CreatePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync", "segments": [ { - "end": 52, + "end": 51, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 51, "start": 27, "type": "SHORT" }, @@ -1504,42 +1693,41 @@ "type": "REQUEST_EXECUTION" }, { - "end": 53, + "end": 52, "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync.py" + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_c078ad83.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceAsyncClient", - "shortName": "PredictionServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", + "shortName": "PredictionApiKeyRegistryClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceAsyncClient.predict", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.create_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService.Predict", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.CreatePredictionApiKeyRegistration", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService", - "shortName": "PredictionService" + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" }, - "shortName": "Predict" + "shortName": "CreatePredictionApiKeyRegistration" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.PredictRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.CreatePredictionApiKeyRegistrationRequest" }, { - "name": "name", + "name": "parent", "type": "str" }, { - "name": "user_event", - "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" + "name": "prediction_api_key_registration", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration" }, { "name": "retry", @@ -1554,22 +1742,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictAsyncPager", - "shortName": "predict" + "resultType": "google.cloud.recommendationengine_v1beta1.types.PredictionApiKeyRegistration", + "shortName": "create_prediction_api_key_registration" }, - "description": "Sample for Predict", - "file": "recommendationengine_v1beta1_generated_prediction_service_predict_async.py", + "description": "Sample for CreatePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionService_Predict_async", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_CreatePredictionApiKeyRegistration_sync", "segments": [ { - "end": 57, + "end": 51, "start": 27, "type": "FULL" }, { - "end": 57, + "end": 51, "start": 27, "type": "SHORT" }, @@ -1579,52 +1767,49 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 50, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 53, - "start": 51, + "end": 48, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 58, - "start": 54, + "end": 52, + "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_service_predict_async.py" + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_create_prediction_api_key_registration_sync_8ddf5d36.py" }, { "canonical": true, "clientMethod": { + "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient", - "shortName": "PredictionServiceClient" + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient", + "shortName": "PredictionApiKeyRegistryAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient.predict", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.delete_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService.Predict", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.DeletePredictionApiKeyRegistration", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService", - "shortName": "PredictionService" + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" }, - "shortName": "Predict" + "shortName": "DeletePredictionApiKeyRegistration" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.PredictRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest" }, { "name": "name", "type": "str" }, - { - "name": "user_event", - "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" - }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1638,22 +1823,21 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager", - "shortName": "predict" + "shortName": "delete_prediction_api_key_registration" }, - "description": "Sample for Predict", - "file": "recommendationengine_v1beta1_generated_prediction_service_predict_sync.py", + "description": "Sample for DeletePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_PredictionService_Predict_sync", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_async", "segments": [ { - "end": 57, + "end": 49, "start": 27, "type": "FULL" }, { - "end": 57, + "end": 49, "start": 27, "type": "SHORT" }, @@ -1663,61 +1847,46 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 50, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 53, - "start": 51, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 58, - "start": 54, + "end": 50, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_prediction_service_predict_sync.py" + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_async.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", - "shortName": "UserEventServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", + "shortName": "PredictionApiKeyRegistryClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.collect_user_event", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.delete_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.CollectUserEvent", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.DeletePredictionApiKeyRegistration", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", - "shortName": "UserEventService" + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" }, - "shortName": "CollectUserEvent" + "shortName": "DeletePredictionApiKeyRegistration" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.CollectUserEventRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "user_event", - "type": "str" + "type": "google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest" }, { - "name": "uri", + "name": "name", "type": "str" }, - { - "name": "ets", - "type": "int" - }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -1731,22 +1900,21 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.api.httpbody_pb2.HttpBody", - "shortName": "collect_user_event" + "shortName": "delete_prediction_api_key_registration" }, - "description": "Sample for CollectUserEvent", - "file": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_async.py", + "description": "Sample for DeletePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_async", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync", "segments": [ { - "end": 52, + "end": 49, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 49, "start": 27, "type": "SHORT" }, @@ -1756,36 +1924,790 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 46, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 49, - "start": 47, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 53, - "start": 50, + "end": 50, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_async.py" + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_f40a4844.py" }, { "canonical": true, "clientMethod": { "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", - "shortName": "UserEventServiceClient" + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", + "shortName": "PredictionApiKeyRegistryClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.collect_user_event", + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.delete_prediction_api_key_registration", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.CollectUserEvent", + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.DeletePredictionApiKeyRegistration", "service": { - "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", - "shortName": "UserEventService" + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" + }, + "shortName": "DeletePredictionApiKeyRegistration" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.DeletePredictionApiKeyRegistrationRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_prediction_api_key_registration" + }, + "description": "Sample for DeletePredictionApiKeyRegistration", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_DeletePredictionApiKeyRegistration_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_delete_prediction_api_key_registration_sync_3de55013.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient", + "shortName": "PredictionApiKeyRegistryAsyncClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryAsyncClient.list_prediction_api_key_registrations", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.ListPredictionApiKeyRegistrations", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" + }, + "shortName": "ListPredictionApiKeyRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager", + "shortName": "list_prediction_api_key_registrations" + }, + "description": "Sample for ListPredictionApiKeyRegistrations", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", + "shortName": "PredictionApiKeyRegistryClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.list_prediction_api_key_registrations", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.ListPredictionApiKeyRegistrations", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" + }, + "shortName": "ListPredictionApiKeyRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager", + "shortName": "list_prediction_api_key_registrations" + }, + "description": "Sample for ListPredictionApiKeyRegistrations", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_2d26cba1.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient", + "shortName": "PredictionApiKeyRegistryClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionApiKeyRegistryClient.list_prediction_api_key_registrations", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry.ListPredictionApiKeyRegistrations", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry", + "shortName": "PredictionApiKeyRegistry" + }, + "shortName": "ListPredictionApiKeyRegistrations" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.ListPredictionApiKeyRegistrationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager", + "shortName": "list_prediction_api_key_registrations" + }, + "description": "Sample for ListPredictionApiKeyRegistrations", + "file": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionApiKeyRegistry_ListPredictionApiKeyRegistrations_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_api_key_registry_list_prediction_api_key_registrations_sync_4cdac270.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceAsyncClient", + "shortName": "PredictionServiceAsyncClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceAsyncClient.predict", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService.Predict", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService", + "shortName": "PredictionService" + }, + "shortName": "Predict" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "user_event", + "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictAsyncPager", + "shortName": "predict" + }, + "description": "Sample for Predict", + "file": "recommendationengine_v1beta1_generated_prediction_service_predict_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionService_Predict_async", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_service_predict_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient", + "shortName": "PredictionServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient.predict", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService.Predict", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService", + "shortName": "PredictionService" + }, + "shortName": "Predict" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "user_event", + "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager", + "shortName": "predict" + }, + "description": "Sample for Predict", + "file": "recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionService_Predict_sync", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_service_predict_sync_31326670.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient", + "shortName": "PredictionServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.PredictionServiceClient.predict", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService.Predict", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.PredictionService", + "shortName": "PredictionService" + }, + "shortName": "Predict" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.PredictRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "user_event", + "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager", + "shortName": "predict" + }, + "description": "Sample for Predict", + "file": "recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_PredictionService_Predict_sync", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_prediction_service_predict_sync_a38ea195.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", + "shortName": "UserEventServiceAsyncClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.collect_user_event", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.CollectUserEvent", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "CollectUserEvent" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.CollectUserEventRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "user_event", + "type": "str" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "ets", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api.httpbody_pb2.HttpBody", + "shortName": "collect_user_event" + }, + "description": "Sample for CollectUserEvent", + "file": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.collect_user_event", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.CollectUserEvent", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "CollectUserEvent" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.CollectUserEventRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "user_event", + "type": "str" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "ets", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api.httpbody_pb2.HttpBody", + "shortName": "collect_user_event" + }, + "description": "Sample for CollectUserEvent", + "file": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_beed3ba7.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.collect_user_event", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.CollectUserEvent", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" }, "shortName": "CollectUserEvent" }, @@ -1826,19 +2748,204 @@ "resultType": "google.api.httpbody_pb2.HttpBody", "shortName": "collect_user_event" }, - "description": "Sample for CollectUserEvent", - "file": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync.py", + "description": "Sample for CollectUserEvent", + "file": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync_9128505b.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", + "shortName": "UserEventServiceAsyncClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.import_user_events", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ImportUserEvents", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "ImportUserEvents" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportUserEventsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "request_id", + "type": "str" + }, + { + "name": "input_config", + "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" + }, + { + "name": "errors_config", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "import_user_events" + }, + "description": "Sample for ImportUserEvents", + "file": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.import_user_events", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ImportUserEvents", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "ImportUserEvents" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportUserEventsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "request_id", + "type": "str" + }, + { + "name": "input_config", + "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" + }, + { + "name": "errors_config", + "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "import_user_events" + }, + "description": "Sample for ImportUserEvents", + "file": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_UserEventService_CollectUserEvent_sync", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync", "segments": [ { - "end": 52, + "end": 55, "start": 27, "type": "FULL" }, { - "end": 52, + "end": 55, "start": 27, "type": "SHORT" }, @@ -1848,32 +2955,31 @@ "type": "CLIENT_INITIALIZATION" }, { - "end": 46, + "end": 45, "start": 41, "type": "REQUEST_INITIALIZATION" }, { - "end": 49, - "start": 47, + "end": 52, + "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 53, - "start": 50, + "end": 56, + "start": 53, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_collect_user_event_sync.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_1b260921.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", - "shortName": "UserEventServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.import_user_events", + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.import_user_events", "method": { "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ImportUserEvents", "service": { @@ -1916,14 +3022,14 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.api_core.operation_async.AsyncOperation", + "resultType": "google.api_core.operation.Operation", "shortName": "import_user_events" }, "description": "Sample for ImportUserEvents", - "file": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_async.py", + "file": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_async", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync", "segments": [ { "end": 55, @@ -1956,45 +3062,38 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_async.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync_202fd725.py" }, { "canonical": true, "clientMethod": { + "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", - "shortName": "UserEventServiceClient" + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", + "shortName": "UserEventServiceAsyncClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.import_user_events", + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.list_user_events", "method": { - "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ImportUserEvents", + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ListUserEvents", "service": { "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", "shortName": "UserEventService" }, - "shortName": "ImportUserEvents" + "shortName": "ListUserEvents" }, "parameters": [ { "name": "request", - "type": "google.cloud.recommendationengine_v1beta1.types.ImportUserEventsRequest" + "type": "google.cloud.recommendationengine_v1beta1.types.ListUserEventsRequest" }, { "name": "parent", "type": "str" }, { - "name": "request_id", + "name": "filter", "type": "str" }, - { - "name": "input_config", - "type": "google.cloud.recommendationengine_v1beta1.types.InputConfig" - }, - { - "name": "errors_config", - "type": "google.cloud.recommendationengine_v1beta1.types.ImportErrorsConfig" - }, { "name": "retry", "type": "google.api_core.retry.Retry" @@ -2008,22 +3107,22 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.api_core.operation.Operation", - "shortName": "import_user_events" + "resultType": "google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager", + "shortName": "list_user_events" }, - "description": "Sample for ImportUserEvents", - "file": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync.py", + "description": "Sample for ListUserEvents", + "file": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_async.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ImportUserEvents_sync", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_async", "segments": [ { - "end": 55, + "end": 52, "start": 27, "type": "FULL" }, { - "end": 55, + "end": 52, "start": 27, "type": "SHORT" }, @@ -2038,27 +3137,26 @@ "type": "REQUEST_INITIALIZATION" }, { - "end": 52, + "end": 48, "start": 46, "type": "REQUEST_EXECUTION" }, { - "end": 56, - "start": 53, + "end": 53, + "start": 49, "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_import_user_events_sync.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_async.py" }, { "canonical": true, "clientMethod": { - "async": true, "client": { - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient", - "shortName": "UserEventServiceAsyncClient" + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" }, - "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceAsyncClient.list_user_events", + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.list_user_events", "method": { "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.ListUserEvents", "service": { @@ -2093,14 +3191,14 @@ "type": "Sequence[Tuple[str, str]" } ], - "resultType": "google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager", + "resultType": "google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager", "shortName": "list_user_events" }, "description": "Sample for ListUserEvents", - "file": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_async.py", + "file": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py", "language": "PYTHON", "origin": "API_DEFINITION", - "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_async", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync", "segments": [ { "end": 52, @@ -2133,7 +3231,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_async.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_d6baec98.py" }, { "canonical": true, @@ -2181,7 +3279,7 @@ "shortName": "list_user_events" }, "description": "Sample for ListUserEvents", - "file": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync.py", + "file": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_UserEventService_ListUserEvents_sync", @@ -2217,7 +3315,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_list_user_events_sync_ccefa7ab.py" }, { "canonical": true, @@ -2358,7 +3456,95 @@ "shortName": "purge_user_events" }, "description": "Sample for PurgeUserEvents", - "file": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync.py", + "file": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_37388c66.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.purge_user_events", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.PurgeUserEvents", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "PurgeUserEvents" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.PurgeUserEventsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "filter", + "type": "str" + }, + { + "name": "force", + "type": "bool" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "purge_user_events" + }, + "description": "Sample for PurgeUserEvents", + "file": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_UserEventService_PurgeUserEvents_sync", @@ -2394,7 +3580,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_purge_user_events_sync_bd0d439c.py" }, { "canonical": true, @@ -2527,7 +3713,91 @@ "shortName": "write_user_event" }, "description": "Sample for WriteUserEvent", - "file": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync.py", + "file": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_62b9e427.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient", + "shortName": "UserEventServiceClient" + }, + "fullName": "google.cloud.recommendationengine_v1beta1.UserEventServiceClient.write_user_event", + "method": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService.WriteUserEvent", + "service": { + "fullName": "google.cloud.recommendationengine.v1beta1.UserEventService", + "shortName": "UserEventService" + }, + "shortName": "WriteUserEvent" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.recommendationengine_v1beta1.types.WriteUserEventRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "user_event", + "type": "google.cloud.recommendationengine_v1beta1.types.UserEvent" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.recommendationengine_v1beta1.types.UserEvent", + "shortName": "write_user_event" + }, + "description": "Sample for WriteUserEvent", + "file": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py", "language": "PYTHON", "origin": "API_DEFINITION", "regionTag": "recommendationengine_v1beta1_generated_UserEventService_WriteUserEvent_sync", @@ -2563,7 +3833,7 @@ "type": "RESPONSE_HANDLING" } ], - "title": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync.py" + "title": "recommendationengine_v1beta1_generated_user_event_service_write_user_event_sync_b58371f7.py" } ] } diff --git a/packages/google-cloud-recommendations-ai/setup.py b/packages/google-cloud-recommendations-ai/setup.py index 389ee810d7fe..ee7fb0594518 100644 --- a/packages/google-cloud-recommendations-ai/setup.py +++ b/packages/google-cloud-recommendations-ai/setup.py @@ -44,9 +44,9 @@ platforms="Posix; MacOS X; Windows", include_package_data=True, install_requires=( - "google-api-core[grpc] >= 1.32.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*", + "google-api-core[grpc] >= 1.33.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*", "proto-plus >= 1.22.0, <2.0.0dev", - "protobuf >= 3.19.0, <5.0.0dev", + "protobuf >= 3.20.1, <5.0.0dev", ), python_requires=">=3.7", classifiers=[ diff --git a/packages/google-cloud-recommendations-ai/testing/constraints-3.7.txt b/packages/google-cloud-recommendations-ai/testing/constraints-3.7.txt index 810c7cb36c5f..12cb23a09318 100644 --- a/packages/google-cloud-recommendations-ai/testing/constraints-3.7.txt +++ b/packages/google-cloud-recommendations-ai/testing/constraints-3.7.txt @@ -4,6 +4,6 @@ # Pin the version to the lower bound. # e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", # Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.32.0 +google-api-core==1.33.1 proto-plus==1.22.0 -protobuf==3.19.0 +protobuf==3.20.1 diff --git a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py index 949399002e6e..7403085fa0fe 100644 --- a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py +++ b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_catalog_service.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -112,6 +119,7 @@ def test__get_default_mtls_endpoint(): [ (CatalogServiceClient, "grpc"), (CatalogServiceAsyncClient, "grpc_asyncio"), + (CatalogServiceClient, "rest"), ], ) def test_catalog_service_client_from_service_account_info(client_class, transport_name): @@ -125,7 +133,11 @@ def test_catalog_service_client_from_service_account_info(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -133,6 +145,7 @@ def test_catalog_service_client_from_service_account_info(client_class, transpor [ (transports.CatalogServiceGrpcTransport, "grpc"), (transports.CatalogServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.CatalogServiceRestTransport, "rest"), ], ) def test_catalog_service_client_service_account_always_use_jwt( @@ -158,6 +171,7 @@ def test_catalog_service_client_service_account_always_use_jwt( [ (CatalogServiceClient, "grpc"), (CatalogServiceAsyncClient, "grpc_asyncio"), + (CatalogServiceClient, "rest"), ], ) def test_catalog_service_client_from_service_account_file(client_class, transport_name): @@ -178,13 +192,18 @@ def test_catalog_service_client_from_service_account_file(client_class, transpor assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) def test_catalog_service_client_get_transport_class(): transport = CatalogServiceClient.get_transport_class() available_transports = [ transports.CatalogServiceGrpcTransport, + transports.CatalogServiceRestTransport, ] assert transport in available_transports @@ -201,6 +220,7 @@ def test_catalog_service_client_get_transport_class(): transports.CatalogServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (CatalogServiceClient, transports.CatalogServiceRestTransport, "rest"), ], ) @mock.patch.object( @@ -346,6 +366,8 @@ def test_catalog_service_client_client_options( "grpc_asyncio", "false", ), + (CatalogServiceClient, transports.CatalogServiceRestTransport, "rest", "true"), + (CatalogServiceClient, transports.CatalogServiceRestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -545,6 +567,7 @@ def test_catalog_service_client_get_mtls_endpoint_and_cert_source(client_class): transports.CatalogServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (CatalogServiceClient, transports.CatalogServiceRestTransport, "rest"), ], ) def test_catalog_service_client_client_options_scopes( @@ -585,6 +608,7 @@ def test_catalog_service_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (CatalogServiceClient, transports.CatalogServiceRestTransport, "rest", None), ], ) def test_catalog_service_client_client_options_credentials_file( @@ -2492,169 +2516,2031 @@ async def test_import_catalog_items_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.CatalogServiceGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + catalog_service.CreateCatalogItemRequest, + dict, + ], +) +def test_create_catalog_item_rest(request_type): + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = CatalogServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request_init["catalog_item"] = { + "id": "id_value", + "category_hierarchies": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "title": "title_value", + "description": "description_value", + "item_attributes": {"categorical_features": {}, "numerical_features": {}}, + "language_code": "language_code_value", + "tags": ["tags_value1", "tags_value2"], + "item_group_id": "item_group_id_value", + "product_metadata": { + "exact_price": {"display_price": 0.1384, "original_price": 0.1479}, + "price_range": {"min_": 0.419, "max_": 0.421}, + "costs": {}, + "currency_code": "currency_code_value", + "stock_state": 1, + "available_quantity": 1919, + "canonical_product_uri": "canonical_product_uri_value", + "images": [{"uri": "uri_value", "height": 633, "width": 544}], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem( + id="id_value", + title="title_value", + description="description_value", + language_code="language_code_value", + tags=["tags_value"], + item_group_id="item_group_id_value", + product_metadata=catalog.ProductCatalogItem( + exact_price=catalog.ProductCatalogItem.ExactPrice(display_price=0.1384) + ), ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.CatalogServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = CatalogServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_catalog_item(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, catalog.CatalogItem) + assert response.id == "id_value" + assert response.title == "title_value" + assert response.description == "description_value" + assert response.language_code == "language_code_value" + assert response.tags == ["tags_value"] + assert response.item_group_id == "item_group_id_value" + + +def test_create_catalog_item_rest_required_fields( + request_type=catalog_service.CreateCatalogItemRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.CatalogServiceGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_catalog_item(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_catalog_item_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = CatalogServiceClient( - client_options=options, - transport=transport, - ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = CatalogServiceClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + unset_fields = transport.create_catalog_item._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "catalogItem", + ) ) + ) - # It is an error to provide scopes and a transport instance. - transport = transports.CatalogServiceGrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_catalog_item_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), ) - with pytest.raises(ValueError): - client = CatalogServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CatalogServiceRestInterceptor, "post_create_catalog_item" + ) as post, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_create_catalog_item" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = catalog_service.CreateCatalogItemRequest.pb( + catalog_service.CreateCatalogItemRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = catalog.CatalogItem.to_json(catalog.CatalogItem()) + + request = catalog_service.CreateCatalogItemRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = catalog.CatalogItem() + + client.create_catalog_item( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) + pre.assert_called_once() + post.assert_called_once() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.CatalogServiceGrpcTransport( + +def test_create_catalog_item_rest_bad_request( + transport: str = "rest", request_type=catalog_service.CreateCatalogItemRequest +): + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = CatalogServiceClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request_init["catalog_item"] = { + "id": "id_value", + "category_hierarchies": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "title": "title_value", + "description": "description_value", + "item_attributes": {"categorical_features": {}, "numerical_features": {}}, + "language_code": "language_code_value", + "tags": ["tags_value1", "tags_value2"], + "item_group_id": "item_group_id_value", + "product_metadata": { + "exact_price": {"display_price": 0.1384, "original_price": 0.1479}, + "price_range": {"min_": 0.419, "max_": 0.421}, + "costs": {}, + "currency_code": "currency_code_value", + "stock_state": 1, + "available_quantity": 1919, + "canonical_product_uri": "canonical_product_uri_value", + "images": [{"uri": "uri_value", "height": 633, "width": 544}], + }, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.CatalogServiceGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_catalog_item(request) + + +def test_create_catalog_item_rest_flattened(): + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.CatalogServiceGrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + catalog_item=catalog.CatalogItem(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_catalog_item(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems" + % client.transport._host, + args[1], + ) + + +def test_create_catalog_item_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_catalog_item( + catalog_service.CreateCatalogItemRequest(), + parent="parent_value", + catalog_item=catalog.CatalogItem(id="id_value"), + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.CatalogServiceGrpcTransport, - transports.CatalogServiceGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() + +def test_create_catalog_item_rest_error(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + catalog_service.GetCatalogItemRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = CatalogServiceClient.get_transport_class(transport_name)( +def test_get_catalog_item_rest(request_type): + client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert transport.kind == transport_name + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem( + id="id_value", + title="title_value", + description="description_value", + language_code="language_code_value", + tags=["tags_value"], + item_group_id="item_group_id_value", + product_metadata=catalog.ProductCatalogItem( + exact_price=catalog.ProductCatalogItem.ExactPrice(display_price=0.1384) + ), + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_catalog_item(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, catalog.CatalogItem) + assert response.id == "id_value" + assert response.title == "title_value" + assert response.description == "description_value" + assert response.language_code == "language_code_value" + assert response.tags == ["tags_value"] + assert response.item_group_id == "item_group_id_value" + + +def test_get_catalog_item_rest_required_fields( + request_type=catalog_service.GetCatalogItemRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. client = CatalogServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert isinstance( - client.transport, - transports.CatalogServiceGrpcTransport, + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_catalog_item(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_catalog_item_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) + unset_fields = transport.get_catalog_item._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) -def test_catalog_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.CatalogServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", - ) +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_catalog_item_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), + ) + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CatalogServiceRestInterceptor, "post_get_catalog_item" + ) as post, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_get_catalog_item" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = catalog_service.GetCatalogItemRequest.pb( + catalog_service.GetCatalogItemRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = catalog.CatalogItem.to_json(catalog.CatalogItem()) + + request = catalog_service.GetCatalogItemRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = catalog.CatalogItem() -def test_catalog_service_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.CatalogServiceTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.CatalogServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), + client.get_catalog_item( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "create_catalog_item", - "get_catalog_item", - "list_catalog_items", - "update_catalog_item", - "delete_catalog_item", - "import_catalog_items", - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) + pre.assert_called_once() + post.assert_called_once() - with pytest.raises(NotImplementedError): - transport.close() - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client +def test_get_catalog_item_rest_bad_request( + transport: str = "rest", request_type=catalog_service.GetCatalogItemRequest +): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_catalog_item(request) + + +def test_get_catalog_item_rest_flattened(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_catalog_item(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}" + % client.transport._host, + args[1], + ) + + +def test_get_catalog_item_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_catalog_item( + catalog_service.GetCatalogItemRequest(), + name="name_value", + ) + + +def test_get_catalog_item_rest_error(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + catalog_service.ListCatalogItemsRequest, + dict, + ], +) +def test_list_catalog_items_rest(request_type): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog_service.ListCatalogItemsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog_service.ListCatalogItemsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_catalog_items(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCatalogItemsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_catalog_items_rest_required_fields( + request_type=catalog_service.ListCatalogItemsRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_catalog_items._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_catalog_items._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = catalog_service.ListCatalogItemsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = catalog_service.ListCatalogItemsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_catalog_items(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_catalog_items_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_catalog_items._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_catalog_items_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), + ) + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CatalogServiceRestInterceptor, "post_list_catalog_items" + ) as post, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_list_catalog_items" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = catalog_service.ListCatalogItemsRequest.pb( + catalog_service.ListCatalogItemsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = catalog_service.ListCatalogItemsResponse.to_json( + catalog_service.ListCatalogItemsResponse() + ) + + request = catalog_service.ListCatalogItemsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = catalog_service.ListCatalogItemsResponse() + + client.list_catalog_items( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_catalog_items_rest_bad_request( + transport: str = "rest", request_type=catalog_service.ListCatalogItemsRequest +): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_catalog_items(request) + + +def test_list_catalog_items_rest_flattened(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog_service.ListCatalogItemsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + filter="filter_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog_service.ListCatalogItemsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_catalog_items(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems" + % client.transport._host, + args[1], + ) + + +def test_list_catalog_items_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_catalog_items( + catalog_service.ListCatalogItemsRequest(), + parent="parent_value", + filter="filter_value", + ) + + +def test_list_catalog_items_rest_pager(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + catalog_service.ListCatalogItemsResponse( + catalog_items=[ + catalog.CatalogItem(), + catalog.CatalogItem(), + catalog.CatalogItem(), + ], + next_page_token="abc", + ), + catalog_service.ListCatalogItemsResponse( + catalog_items=[], + next_page_token="def", + ), + catalog_service.ListCatalogItemsResponse( + catalog_items=[ + catalog.CatalogItem(), + ], + next_page_token="ghi", + ), + catalog_service.ListCatalogItemsResponse( + catalog_items=[ + catalog.CatalogItem(), + catalog.CatalogItem(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + catalog_service.ListCatalogItemsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3" + } + + pager = client.list_catalog_items(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, catalog.CatalogItem) for i in results) + + pages = list(client.list_catalog_items(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + catalog_service.UpdateCatalogItemRequest, + dict, + ], +) +def test_update_catalog_item_rest(request_type): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request_init["catalog_item"] = { + "id": "id_value", + "category_hierarchies": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "title": "title_value", + "description": "description_value", + "item_attributes": {"categorical_features": {}, "numerical_features": {}}, + "language_code": "language_code_value", + "tags": ["tags_value1", "tags_value2"], + "item_group_id": "item_group_id_value", + "product_metadata": { + "exact_price": {"display_price": 0.1384, "original_price": 0.1479}, + "price_range": {"min_": 0.419, "max_": 0.421}, + "costs": {}, + "currency_code": "currency_code_value", + "stock_state": 1, + "available_quantity": 1919, + "canonical_product_uri": "canonical_product_uri_value", + "images": [{"uri": "uri_value", "height": 633, "width": 544}], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem( + id="id_value", + title="title_value", + description="description_value", + language_code="language_code_value", + tags=["tags_value"], + item_group_id="item_group_id_value", + product_metadata=catalog.ProductCatalogItem( + exact_price=catalog.ProductCatalogItem.ExactPrice(display_price=0.1384) + ), + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_catalog_item(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, catalog.CatalogItem) + assert response.id == "id_value" + assert response.title == "title_value" + assert response.description == "description_value" + assert response.language_code == "language_code_value" + assert response.tags == ["tags_value"] + assert response.item_group_id == "item_group_id_value" + + +def test_update_catalog_item_rest_required_fields( + request_type=catalog_service.UpdateCatalogItemRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_catalog_item._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_catalog_item(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_catalog_item_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_catalog_item._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("updateMask",)) + & set( + ( + "name", + "catalogItem", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_catalog_item_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), + ) + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CatalogServiceRestInterceptor, "post_update_catalog_item" + ) as post, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_update_catalog_item" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = catalog_service.UpdateCatalogItemRequest.pb( + catalog_service.UpdateCatalogItemRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = catalog.CatalogItem.to_json(catalog.CatalogItem()) + + request = catalog_service.UpdateCatalogItemRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = catalog.CatalogItem() + + client.update_catalog_item( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_catalog_item_rest_bad_request( + transport: str = "rest", request_type=catalog_service.UpdateCatalogItemRequest +): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request_init["catalog_item"] = { + "id": "id_value", + "category_hierarchies": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "title": "title_value", + "description": "description_value", + "item_attributes": {"categorical_features": {}, "numerical_features": {}}, + "language_code": "language_code_value", + "tags": ["tags_value1", "tags_value2"], + "item_group_id": "item_group_id_value", + "product_metadata": { + "exact_price": {"display_price": 0.1384, "original_price": 0.1479}, + "price_range": {"min_": 0.419, "max_": 0.421}, + "costs": {}, + "currency_code": "currency_code_value", + "stock_state": 1, + "available_quantity": 1919, + "canonical_product_uri": "canonical_product_uri_value", + "images": [{"uri": "uri_value", "height": 633, "width": 544}], + }, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_catalog_item(request) + + +def test_update_catalog_item_rest_flattened(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = catalog.CatalogItem() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + catalog_item=catalog.CatalogItem(id="id_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = catalog.CatalogItem.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_catalog_item(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}" + % client.transport._host, + args[1], + ) + + +def test_update_catalog_item_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_catalog_item( + catalog_service.UpdateCatalogItemRequest(), + name="name_value", + catalog_item=catalog.CatalogItem(id="id_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_update_catalog_item_rest_error(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + catalog_service.DeleteCatalogItemRequest, + dict, + ], +) +def test_delete_catalog_item_rest(request_type): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_catalog_item(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_catalog_item_rest_required_fields( + request_type=catalog_service.DeleteCatalogItemRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_catalog_item._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_catalog_item(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_catalog_item_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_catalog_item._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_catalog_item_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), + ) + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_delete_catalog_item" + ) as pre: + pre.assert_not_called() + pb_message = catalog_service.DeleteCatalogItemRequest.pb( + catalog_service.DeleteCatalogItemRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = catalog_service.DeleteCatalogItemRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_catalog_item( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_catalog_item_rest_bad_request( + transport: str = "rest", request_type=catalog_service.DeleteCatalogItemRequest +): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_catalog_item(request) + + +def test_delete_catalog_item_rest_flattened(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/catalogItems/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_catalog_item(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**}" + % client.transport._host, + args[1], + ) + + +def test_delete_catalog_item_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_catalog_item( + catalog_service.DeleteCatalogItemRequest(), + name="name_value", + ) + + +def test_delete_catalog_item_rest_error(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + import_.ImportCatalogItemsRequest, + dict, + ], +) +def test_import_catalog_items_rest(request_type): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.import_catalog_items(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_import_catalog_items_rest_required_fields( + request_type=import_.ImportCatalogItemsRequest, +): + transport_class = transports.CatalogServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_catalog_items._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_catalog_items._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.import_catalog_items(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_import_catalog_items_rest_unset_required_fields(): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.import_catalog_items._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "inputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_catalog_items_rest_interceptors(null_interceptor): + transport = transports.CatalogServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CatalogServiceRestInterceptor(), + ) + client = CatalogServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.CatalogServiceRestInterceptor, "post_import_catalog_items" + ) as post, mock.patch.object( + transports.CatalogServiceRestInterceptor, "pre_import_catalog_items" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = import_.ImportCatalogItemsRequest.pb( + import_.ImportCatalogItemsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = import_.ImportCatalogItemsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.import_catalog_items( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_catalog_items_rest_bad_request( + transport: str = "rest", request_type=import_.ImportCatalogItemsRequest +): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/catalogs/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.import_catalog_items(request) + + +def test_import_catalog_items_rest_flattened(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + request_id="request_id_value", + input_config=import_.InputConfig( + catalog_inline_source=import_.CatalogInlineSource( + catalog_items=[catalog.CatalogItem(id="id_value")] + ) + ), + errors_config=import_.ImportErrorsConfig(gcs_prefix="gcs_prefix_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.import_catalog_items(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems:import" + % client.transport._host, + args[1], + ) + + +def test_import_catalog_items_rest_flattened_error(transport: str = "rest"): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.import_catalog_items( + import_.ImportCatalogItemsRequest(), + parent="parent_value", + request_id="request_id_value", + input_config=import_.InputConfig( + catalog_inline_source=import_.CatalogInlineSource( + catalog_items=[catalog.CatalogItem(id="id_value")] + ) + ), + errors_config=import_.ImportErrorsConfig(gcs_prefix="gcs_prefix_value"), + ) + + +def test_import_catalog_items_rest_error(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CatalogServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CatalogServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CatalogServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CatalogServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = CatalogServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.CatalogServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CatalogServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CatalogServiceGrpcTransport, + transports.CatalogServiceGrpcAsyncIOTransport, + transports.CatalogServiceRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = CatalogServiceClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.CatalogServiceGrpcTransport, + ) + + +def test_catalog_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.CatalogServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_catalog_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.recommendationengine_v1beta1.services.catalog_service.transports.CatalogServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.CatalogServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_catalog_item", + "get_catalog_item", + "list_catalog_items", + "update_catalog_item", + "delete_catalog_item", + "import_catalog_items", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() def test_catalog_service_base_transport_with_credentials_file(): @@ -2726,6 +4612,7 @@ def test_catalog_service_transport_auth_adc(transport_class): [ transports.CatalogServiceGrpcTransport, transports.CatalogServiceGrpcAsyncIOTransport, + transports.CatalogServiceRestTransport, ], ) def test_catalog_service_transport_auth_gdch_credentials(transport_class): @@ -2823,11 +4710,40 @@ def test_catalog_service_grpc_transport_client_cert_source_for_mtls(transport_cl ) +def test_catalog_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.CatalogServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_catalog_service_rest_lro_client(): + client = CatalogServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_catalog_service_host_no_port(transport_name): @@ -2838,7 +4754,11 @@ def test_catalog_service_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -2846,6 +4766,7 @@ def test_catalog_service_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_catalog_service_host_with_port(transport_name): @@ -2856,7 +4777,48 @@ def test_catalog_service_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:8000") + assert client.transport._host == ( + "recommendationengine.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_catalog_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = CatalogServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = CatalogServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_catalog_item._session + session2 = client2.transport.create_catalog_item._session + assert session1 != session2 + session1 = client1.transport.get_catalog_item._session + session2 = client2.transport.get_catalog_item._session + assert session1 != session2 + session1 = client1.transport.list_catalog_items._session + session2 = client2.transport.list_catalog_items._session + assert session1 != session2 + session1 = client1.transport.update_catalog_item._session + session2 = client2.transport.update_catalog_item._session + assert session1 != session2 + session1 = client1.transport.delete_catalog_item._session + session2 = client2.transport.delete_catalog_item._session + assert session1 != session2 + session1 = client1.transport.import_catalog_items._session + session2 = client2.transport.import_catalog_items._session + assert session1 != session2 def test_catalog_service_grpc_transport_channel(): @@ -3187,6 +5149,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -3204,6 +5167,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py index 944ee32e883b..0e5c2ef9b585 100644 --- a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py +++ b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_api_key_registry.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -106,6 +113,7 @@ def test__get_default_mtls_endpoint(): [ (PredictionApiKeyRegistryClient, "grpc"), (PredictionApiKeyRegistryAsyncClient, "grpc_asyncio"), + (PredictionApiKeyRegistryClient, "rest"), ], ) def test_prediction_api_key_registry_client_from_service_account_info( @@ -121,7 +129,11 @@ def test_prediction_api_key_registry_client_from_service_account_info( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -129,6 +141,7 @@ def test_prediction_api_key_registry_client_from_service_account_info( [ (transports.PredictionApiKeyRegistryGrpcTransport, "grpc"), (transports.PredictionApiKeyRegistryGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.PredictionApiKeyRegistryRestTransport, "rest"), ], ) def test_prediction_api_key_registry_client_service_account_always_use_jwt( @@ -154,6 +167,7 @@ def test_prediction_api_key_registry_client_service_account_always_use_jwt( [ (PredictionApiKeyRegistryClient, "grpc"), (PredictionApiKeyRegistryAsyncClient, "grpc_asyncio"), + (PredictionApiKeyRegistryClient, "rest"), ], ) def test_prediction_api_key_registry_client_from_service_account_file( @@ -176,13 +190,18 @@ def test_prediction_api_key_registry_client_from_service_account_file( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) def test_prediction_api_key_registry_client_get_transport_class(): transport = PredictionApiKeyRegistryClient.get_transport_class() available_transports = [ transports.PredictionApiKeyRegistryGrpcTransport, + transports.PredictionApiKeyRegistryRestTransport, ] assert transport in available_transports @@ -203,6 +222,11 @@ def test_prediction_api_key_registry_client_get_transport_class(): transports.PredictionApiKeyRegistryGrpcAsyncIOTransport, "grpc_asyncio", ), + ( + PredictionApiKeyRegistryClient, + transports.PredictionApiKeyRegistryRestTransport, + "rest", + ), ], ) @mock.patch.object( @@ -362,6 +386,18 @@ def test_prediction_api_key_registry_client_client_options( "grpc_asyncio", "false", ), + ( + PredictionApiKeyRegistryClient, + transports.PredictionApiKeyRegistryRestTransport, + "rest", + "true", + ), + ( + PredictionApiKeyRegistryClient, + transports.PredictionApiKeyRegistryRestTransport, + "rest", + "false", + ), ], ) @mock.patch.object( @@ -568,6 +604,11 @@ def test_prediction_api_key_registry_client_get_mtls_endpoint_and_cert_source( transports.PredictionApiKeyRegistryGrpcAsyncIOTransport, "grpc_asyncio", ), + ( + PredictionApiKeyRegistryClient, + transports.PredictionApiKeyRegistryRestTransport, + "rest", + ), ], ) def test_prediction_api_key_registry_client_client_options_scopes( @@ -608,6 +649,12 @@ def test_prediction_api_key_registry_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + ( + PredictionApiKeyRegistryClient, + transports.PredictionApiKeyRegistryRestTransport, + "rest", + None, + ), ], ) def test_prediction_api_key_registry_client_client_options_credentials_file( @@ -1734,6 +1781,980 @@ async def test_delete_prediction_api_key_registration_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, + dict, + ], +) +def test_create_prediction_api_key_registration_rest(request_type): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = prediction_apikey_registry_service.PredictionApiKeyRegistration( + api_key="api_key_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration.pb( + return_value + ) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.create_prediction_api_key_registration(request) + + # Establish that the response is the type that we expect. + assert isinstance( + response, prediction_apikey_registry_service.PredictionApiKeyRegistration + ) + assert response.api_key == "api_key_value" + + +def test_create_prediction_api_key_registration_rest_required_fields( + request_type=prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, +): + transport_class = transports.PredictionApiKeyRegistryRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_prediction_api_key_registration._get_unset_required_fields( + jsonified_request + ) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_prediction_api_key_registration._get_unset_required_fields( + jsonified_request + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = prediction_apikey_registry_service.PredictionApiKeyRegistration() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration.pb( + return_value + ) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.create_prediction_api_key_registration(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_prediction_api_key_registration_rest_unset_required_fields(): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.create_prediction_api_key_registration._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "predictionApiKeyRegistration", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_prediction_api_key_registration_rest_interceptors(null_interceptor): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.PredictionApiKeyRegistryRestInterceptor(), + ) + client = PredictionApiKeyRegistryClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.PredictionApiKeyRegistryRestInterceptor, + "post_create_prediction_api_key_registration", + ) as post, mock.patch.object( + transports.PredictionApiKeyRegistryRestInterceptor, + "pre_create_prediction_api_key_registration", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest.pb( + prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration.to_json( + prediction_apikey_registry_service.PredictionApiKeyRegistration() + ) + ) + + request = ( + prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest() + ) + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration() + ) + + client.create_prediction_api_key_registration( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_prediction_api_key_registration_rest_bad_request( + transport: str = "rest", + request_type=prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest, +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.create_prediction_api_key_registration(request) + + +def test_create_prediction_api_key_registration_rest_flattened(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = prediction_apikey_registry_service.PredictionApiKeyRegistration() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + prediction_api_key_registration=prediction_apikey_registry_service.PredictionApiKeyRegistration( + api_key="api_key_value" + ), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = ( + prediction_apikey_registry_service.PredictionApiKeyRegistration.pb( + return_value + ) + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.create_prediction_api_key_registration(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations" + % client.transport._host, + args[1], + ) + + +def test_create_prediction_api_key_registration_rest_flattened_error( + transport: str = "rest", +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_prediction_api_key_registration( + prediction_apikey_registry_service.CreatePredictionApiKeyRegistrationRequest(), + parent="parent_value", + prediction_api_key_registration=prediction_apikey_registry_service.PredictionApiKeyRegistration( + api_key="api_key_value" + ), + ) + + +def test_create_prediction_api_key_registration_rest_error(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, + dict, + ], +) +def test_list_prediction_api_key_registrations_rest(request_type): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_prediction_api_key_registrations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPredictionApiKeyRegistrationsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_prediction_api_key_registrations_rest_required_fields( + request_type=prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, +): + transport_class = transports.PredictionApiKeyRegistryRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_prediction_api_key_registrations._get_unset_required_fields( + jsonified_request + ) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_prediction_api_key_registrations._get_unset_required_fields( + jsonified_request + ) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse() + ) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_prediction_api_key_registrations(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_prediction_api_key_registrations_rest_unset_required_fields(): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.list_prediction_api_key_registrations._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_prediction_api_key_registrations_rest_interceptors(null_interceptor): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.PredictionApiKeyRegistryRestInterceptor(), + ) + client = PredictionApiKeyRegistryClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.PredictionApiKeyRegistryRestInterceptor, + "post_list_prediction_api_key_registrations", + ) as post, mock.patch.object( + transports.PredictionApiKeyRegistryRestInterceptor, + "pre_list_prediction_api_key_registrations", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest.pb( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.to_json( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse() + ) + + request = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest() + ) + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse() + ) + + client.list_prediction_api_key_registrations( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_prediction_api_key_registrations_rest_bad_request( + transport: str = "rest", + request_type=prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest, +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_prediction_api_key_registrations(request) + + +def test_list_prediction_api_key_registrations_rest_flattened(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse() + ) + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_prediction_api_key_registrations(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations" + % client.transport._host, + args[1], + ) + + +def test_list_prediction_api_key_registrations_rest_flattened_error( + transport: str = "rest", +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_prediction_api_key_registrations( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsRequest(), + parent="parent_value", + ) + + +def test_list_prediction_api_key_registrations_rest_pager(transport: str = "rest"): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse( + prediction_api_key_registrations=[ + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + ], + next_page_token="abc", + ), + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse( + prediction_api_key_registrations=[], + next_page_token="def", + ), + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse( + prediction_api_key_registrations=[ + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + ], + next_page_token="ghi", + ), + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse( + prediction_api_key_registrations=[ + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + prediction_apikey_registry_service.PredictionApiKeyRegistration(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + prediction_apikey_registry_service.ListPredictionApiKeyRegistrationsResponse.to_json( + x + ) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + pager = client.list_prediction_api_key_registrations(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance( + i, prediction_apikey_registry_service.PredictionApiKeyRegistration + ) + for i in results + ) + + pages = list( + client.list_prediction_api_key_registrations(request=sample_request).pages + ) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, + dict, + ], +) +def test_delete_prediction_api_key_registration_rest(request_type): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/predictionApiKeyRegistrations/sample5" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_prediction_api_key_registration(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_prediction_api_key_registration_rest_required_fields( + request_type=prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, +): + transport_class = transports.PredictionApiKeyRegistryRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_prediction_api_key_registration._get_unset_required_fields( + jsonified_request + ) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_prediction_api_key_registration._get_unset_required_fields( + jsonified_request + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_prediction_api_key_registration(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_prediction_api_key_registration_rest_unset_required_fields(): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.delete_prediction_api_key_registration._get_unset_required_fields({}) + ) + assert set(unset_fields) == (set(()) & set(("name",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_prediction_api_key_registration_rest_interceptors(null_interceptor): + transport = transports.PredictionApiKeyRegistryRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.PredictionApiKeyRegistryRestInterceptor(), + ) + client = PredictionApiKeyRegistryClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.PredictionApiKeyRegistryRestInterceptor, + "pre_delete_prediction_api_key_registration", + ) as pre: + pre.assert_not_called() + pb_message = prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest.pb( + prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = ( + prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest() + ) + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_prediction_api_key_registration( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_prediction_api_key_registration_rest_bad_request( + transport: str = "rest", + request_type=prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest, +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/predictionApiKeyRegistrations/sample5" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_prediction_api_key_registration(request) + + +def test_delete_prediction_api_key_registration_rest_flattened(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/predictionApiKeyRegistrations/sample5" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_prediction_api_key_registration(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/predictionApiKeyRegistrations/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_prediction_api_key_registration_rest_flattened_error( + transport: str = "rest", +): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_prediction_api_key_registration( + prediction_apikey_registry_service.DeletePredictionApiKeyRegistrationRequest(), + name="name_value", + ) + + +def test_delete_prediction_api_key_registration_rest_error(): + client = PredictionApiKeyRegistryClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.PredictionApiKeyRegistryGrpcTransport( @@ -1815,6 +2836,7 @@ def test_transport_get_channel(): [ transports.PredictionApiKeyRegistryGrpcTransport, transports.PredictionApiKeyRegistryGrpcAsyncIOTransport, + transports.PredictionApiKeyRegistryRestTransport, ], ) def test_transport_adc(transport_class): @@ -1829,6 +2851,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1960,6 +2983,7 @@ def test_prediction_api_key_registry_transport_auth_adc(transport_class): [ transports.PredictionApiKeyRegistryGrpcTransport, transports.PredictionApiKeyRegistryGrpcAsyncIOTransport, + transports.PredictionApiKeyRegistryRestTransport, ], ) def test_prediction_api_key_registry_transport_auth_gdch_credentials(transport_class): @@ -2061,11 +3085,23 @@ def test_prediction_api_key_registry_grpc_transport_client_cert_source_for_mtls( ) +def test_prediction_api_key_registry_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.PredictionApiKeyRegistryRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_prediction_api_key_registry_host_no_port(transport_name): @@ -2076,7 +3112,11 @@ def test_prediction_api_key_registry_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -2084,6 +3124,7 @@ def test_prediction_api_key_registry_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_prediction_api_key_registry_host_with_port(transport_name): @@ -2094,7 +3135,39 @@ def test_prediction_api_key_registry_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:8000") + assert client.transport._host == ( + "recommendationengine.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_prediction_api_key_registry_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = PredictionApiKeyRegistryClient( + credentials=creds1, + transport=transport_name, + ) + client2 = PredictionApiKeyRegistryClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_prediction_api_key_registration._session + session2 = client2.transport.create_prediction_api_key_registration._session + assert session1 != session2 + session1 = client1.transport.list_prediction_api_key_registrations._session + session2 = client2.transport.list_prediction_api_key_registrations._session + assert session1 != session2 + session1 = client1.transport.delete_prediction_api_key_registration._session + session2 = client2.transport.delete_prediction_api_key_registration._session + assert session1 != session2 def test_prediction_api_key_registry_grpc_transport_channel(): @@ -2434,6 +3507,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2451,6 +3525,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py index a13e3afbfd66..96cfb81036eb 100644 --- a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py +++ b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_prediction_service.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api_core import client_options from google.api_core import exceptions as core_exceptions @@ -107,6 +114,7 @@ def test__get_default_mtls_endpoint(): [ (PredictionServiceClient, "grpc"), (PredictionServiceAsyncClient, "grpc_asyncio"), + (PredictionServiceClient, "rest"), ], ) def test_prediction_service_client_from_service_account_info( @@ -122,7 +130,11 @@ def test_prediction_service_client_from_service_account_info( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -130,6 +142,7 @@ def test_prediction_service_client_from_service_account_info( [ (transports.PredictionServiceGrpcTransport, "grpc"), (transports.PredictionServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.PredictionServiceRestTransport, "rest"), ], ) def test_prediction_service_client_service_account_always_use_jwt( @@ -155,6 +168,7 @@ def test_prediction_service_client_service_account_always_use_jwt( [ (PredictionServiceClient, "grpc"), (PredictionServiceAsyncClient, "grpc_asyncio"), + (PredictionServiceClient, "rest"), ], ) def test_prediction_service_client_from_service_account_file( @@ -177,13 +191,18 @@ def test_prediction_service_client_from_service_account_file( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) def test_prediction_service_client_get_transport_class(): transport = PredictionServiceClient.get_transport_class() available_transports = [ transports.PredictionServiceGrpcTransport, + transports.PredictionServiceRestTransport, ] assert transport in available_transports @@ -200,6 +219,7 @@ def test_prediction_service_client_get_transport_class(): transports.PredictionServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (PredictionServiceClient, transports.PredictionServiceRestTransport, "rest"), ], ) @mock.patch.object( @@ -355,6 +375,18 @@ def test_prediction_service_client_client_options( "grpc_asyncio", "false", ), + ( + PredictionServiceClient, + transports.PredictionServiceRestTransport, + "rest", + "true", + ), + ( + PredictionServiceClient, + transports.PredictionServiceRestTransport, + "rest", + "false", + ), ], ) @mock.patch.object( @@ -554,6 +586,7 @@ def test_prediction_service_client_get_mtls_endpoint_and_cert_source(client_clas transports.PredictionServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (PredictionServiceClient, transports.PredictionServiceRestTransport, "rest"), ], ) def test_prediction_service_client_client_options_scopes( @@ -594,6 +627,12 @@ def test_prediction_service_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + ( + PredictionServiceClient, + transports.PredictionServiceRestTransport, + "rest", + None, + ), ], ) def test_prediction_service_client_client_options_credentials_file( @@ -1154,6 +1193,357 @@ async def test_predict_async_pages(): assert page_.raw_page.next_page_token == token +@pytest.mark.parametrize( + "request_type", + [ + prediction_service.PredictRequest, + dict, + ], +) +def test_predict_rest(request_type): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/placements/sample5" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = prediction_service.PredictResponse( + recommendation_token="recommendation_token_value", + items_missing_in_catalog=["items_missing_in_catalog_value"], + dry_run=True, + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = prediction_service.PredictResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.predict(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.PredictPager) + assert response.recommendation_token == "recommendation_token_value" + assert response.items_missing_in_catalog == ["items_missing_in_catalog_value"] + assert response.dry_run is True + assert response.next_page_token == "next_page_token_value" + + +def test_predict_rest_required_fields(request_type=prediction_service.PredictRequest): + transport_class = transports.PredictionServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).predict._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).predict._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = prediction_service.PredictResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = prediction_service.PredictResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.predict(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_predict_rest_unset_required_fields(): + transport = transports.PredictionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.predict._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "name", + "userEvent", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_predict_rest_interceptors(null_interceptor): + transport = transports.PredictionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.PredictionServiceRestInterceptor(), + ) + client = PredictionServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.PredictionServiceRestInterceptor, "post_predict" + ) as post, mock.patch.object( + transports.PredictionServiceRestInterceptor, "pre_predict" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = prediction_service.PredictRequest.pb( + prediction_service.PredictRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = prediction_service.PredictResponse.to_json( + prediction_service.PredictResponse() + ) + + request = prediction_service.PredictRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = prediction_service.PredictResponse() + + client.predict( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_predict_rest_bad_request( + transport: str = "rest", request_type=prediction_service.PredictRequest +): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/placements/sample5" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.predict(request) + + +def test_predict_rest_flattened(): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = prediction_service.PredictResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/placements/sample5" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + user_event=gcr_user_event.UserEvent(event_type="event_type_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = prediction_service.PredictResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.predict(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/placements/*}:predict" + % client.transport._host, + args[1], + ) + + +def test_predict_rest_flattened_error(transport: str = "rest"): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.predict( + prediction_service.PredictRequest(), + name="name_value", + user_event=gcr_user_event.UserEvent(event_type="event_type_value"), + ) + + +def test_predict_rest_pager(transport: str = "rest"): + client = PredictionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + prediction_service.PredictResponse( + results=[ + prediction_service.PredictResponse.PredictionResult(), + prediction_service.PredictResponse.PredictionResult(), + prediction_service.PredictResponse.PredictionResult(), + ], + next_page_token="abc", + ), + prediction_service.PredictResponse( + results=[], + next_page_token="def", + ), + prediction_service.PredictResponse( + results=[ + prediction_service.PredictResponse.PredictionResult(), + ], + next_page_token="ghi", + ), + prediction_service.PredictResponse( + results=[ + prediction_service.PredictResponse.PredictionResult(), + prediction_service.PredictResponse.PredictionResult(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + prediction_service.PredictResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "name": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4/placements/sample5" + } + + pager = client.predict(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, prediction_service.PredictResponse.PredictionResult) + for i in results + ) + + pages = list(client.predict(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.PredictionServiceGrpcTransport( @@ -1235,6 +1625,7 @@ def test_transport_get_channel(): [ transports.PredictionServiceGrpcTransport, transports.PredictionServiceGrpcAsyncIOTransport, + transports.PredictionServiceRestTransport, ], ) def test_transport_adc(transport_class): @@ -1249,6 +1640,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1376,6 +1768,7 @@ def test_prediction_service_transport_auth_adc(transport_class): [ transports.PredictionServiceGrpcTransport, transports.PredictionServiceGrpcAsyncIOTransport, + transports.PredictionServiceRestTransport, ], ) def test_prediction_service_transport_auth_gdch_credentials(transport_class): @@ -1473,11 +1866,23 @@ def test_prediction_service_grpc_transport_client_cert_source_for_mtls(transport ) +def test_prediction_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.PredictionServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_prediction_service_host_no_port(transport_name): @@ -1488,7 +1893,11 @@ def test_prediction_service_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -1496,6 +1905,7 @@ def test_prediction_service_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_prediction_service_host_with_port(transport_name): @@ -1506,7 +1916,33 @@ def test_prediction_service_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:8000") + assert client.transport._host == ( + "recommendationengine.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_prediction_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = PredictionServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = PredictionServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.predict._session + session2 = client2.transport.predict._session + assert session1 != session2 def test_prediction_service_grpc_transport_channel(): @@ -1811,6 +2247,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1828,6 +2265,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py index 023874db9a57..5cecad59da38 100644 --- a/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py +++ b/packages/google-cloud-recommendations-ai/tests/unit/gapic/recommendationengine_v1beta1/test_user_event_service.py @@ -24,10 +24,17 @@ import grpc from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json import math import pytest from proto.marshal.rules.dates import DurationRule, TimestampRule from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format from google.api import httpbody_pb2 # type: ignore from google.api_core import client_options @@ -115,6 +122,7 @@ def test__get_default_mtls_endpoint(): [ (UserEventServiceClient, "grpc"), (UserEventServiceAsyncClient, "grpc_asyncio"), + (UserEventServiceClient, "rest"), ], ) def test_user_event_service_client_from_service_account_info( @@ -130,7 +138,11 @@ def test_user_event_service_client_from_service_account_info( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -138,6 +150,7 @@ def test_user_event_service_client_from_service_account_info( [ (transports.UserEventServiceGrpcTransport, "grpc"), (transports.UserEventServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.UserEventServiceRestTransport, "rest"), ], ) def test_user_event_service_client_service_account_always_use_jwt( @@ -163,6 +176,7 @@ def test_user_event_service_client_service_account_always_use_jwt( [ (UserEventServiceClient, "grpc"), (UserEventServiceAsyncClient, "grpc_asyncio"), + (UserEventServiceClient, "rest"), ], ) def test_user_event_service_client_from_service_account_file( @@ -185,13 +199,18 @@ def test_user_event_service_client_from_service_account_file( assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) def test_user_event_service_client_get_transport_class(): transport = UserEventServiceClient.get_transport_class() available_transports = [ transports.UserEventServiceGrpcTransport, + transports.UserEventServiceRestTransport, ] assert transport in available_transports @@ -208,6 +227,7 @@ def test_user_event_service_client_get_transport_class(): transports.UserEventServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (UserEventServiceClient, transports.UserEventServiceRestTransport, "rest"), ], ) @mock.patch.object( @@ -363,6 +383,18 @@ def test_user_event_service_client_client_options( "grpc_asyncio", "false", ), + ( + UserEventServiceClient, + transports.UserEventServiceRestTransport, + "rest", + "true", + ), + ( + UserEventServiceClient, + transports.UserEventServiceRestTransport, + "rest", + "false", + ), ], ) @mock.patch.object( @@ -562,6 +594,7 @@ def test_user_event_service_client_get_mtls_endpoint_and_cert_source(client_clas transports.UserEventServiceGrpcAsyncIOTransport, "grpc_asyncio", ), + (UserEventServiceClient, transports.UserEventServiceRestTransport, "rest"), ], ) def test_user_event_service_client_client_options_scopes( @@ -602,6 +635,12 @@ def test_user_event_service_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + ( + UserEventServiceClient, + transports.UserEventServiceRestTransport, + "rest", + None, + ), ], ) def test_user_event_service_client_client_options_credentials_file( @@ -2228,195 +2267,1822 @@ async def test_import_user_events_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.UserEventServiceGrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + user_event_service.WriteUserEventRequest, + dict, + ], +) +def test_write_user_event_rest(request_type): + client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - with pytest.raises(ValueError): - client = UserEventServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request_init["user_event"] = { + "event_type": "event_type_value", + "user_info": { + "visitor_id": "visitor_id_value", + "user_id": "user_id_value", + "ip_address": "ip_address_value", + "user_agent": "user_agent_value", + "direct_user_request": True, + }, + "event_detail": { + "uri": "uri_value", + "referrer_uri": "referrer_uri_value", + "page_view_id": "page_view_id_value", + "experiment_ids": ["experiment_ids_value1", "experiment_ids_value2"], + "recommendation_token": "recommendation_token_value", + "event_attributes": {"categorical_features": {}, "numerical_features": {}}, + }, + "product_event_detail": { + "search_query": "search_query_value", + "page_categories": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "product_details": [ + { + "id": "id_value", + "currency_code": "currency_code_value", + "original_price": 0.1479, + "display_price": 0.1384, + "stock_state": 1, + "quantity": 895, + "available_quantity": 1919, + "item_attributes": {}, + } + ], + "list_id": "list_id_value", + "cart_id": "cart_id_value", + "purchase_transaction": { + "id": "id_value", + "revenue": 0.762, + "taxes": {}, + "costs": {}, + "currency_code": "currency_code_value", + }, + }, + "event_time": {"seconds": 751, "nanos": 543}, + "event_source": 1, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = gcr_user_event.UserEvent( + event_type="event_type_value", + event_source=gcr_user_event.UserEvent.EventSource.AUTOML, ) - # It is an error to provide a credentials file and a transport instance. - transport = transports.UserEventServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = UserEventServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_user_event.UserEvent.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.write_user_event(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gcr_user_event.UserEvent) + assert response.event_type == "event_type_value" + assert response.event_source == gcr_user_event.UserEvent.EventSource.AUTOML + + +def test_write_user_event_rest_required_fields( + request_type=user_event_service.WriteUserEventRequest, +): + transport_class = transports.UserEventServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, ) + ) - # It is an error to provide an api_key and a transport instance. - transport = transports.UserEventServiceGrpcTransport( + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).write_user_event._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).write_user_event._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gcr_user_event.UserEvent() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = gcr_user_event.UserEvent.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.write_user_event(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_write_user_event_rest_unset_required_fields(): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = UserEventServiceClient( - client_options=options, - transport=transport, - ) - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = UserEventServiceClient( - client_options=options, credentials=ga_credentials.AnonymousCredentials() + unset_fields = transport.write_user_event._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "userEvent", + ) ) + ) - # It is an error to provide scopes and a transport instance. - transport = transports.UserEventServiceGrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_write_user_event_rest_interceptors(null_interceptor): + transport = transports.UserEventServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.UserEventServiceRestInterceptor(), ) - with pytest.raises(ValueError): - client = UserEventServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = UserEventServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.UserEventServiceRestInterceptor, "post_write_user_event" + ) as post, mock.patch.object( + transports.UserEventServiceRestInterceptor, "pre_write_user_event" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = user_event_service.WriteUserEventRequest.pb( + user_event_service.WriteUserEventRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = gcr_user_event.UserEvent.to_json( + gcr_user_event.UserEvent() ) + request = user_event_service.WriteUserEventRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gcr_user_event.UserEvent() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.UserEventServiceGrpcTransport( + client.write_user_event( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_write_user_event_rest_bad_request( + transport: str = "rest", request_type=user_event_service.WriteUserEventRequest +): + client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = UserEventServiceClient(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request_init["user_event"] = { + "event_type": "event_type_value", + "user_info": { + "visitor_id": "visitor_id_value", + "user_id": "user_id_value", + "ip_address": "ip_address_value", + "user_agent": "user_agent_value", + "direct_user_request": True, + }, + "event_detail": { + "uri": "uri_value", + "referrer_uri": "referrer_uri_value", + "page_view_id": "page_view_id_value", + "experiment_ids": ["experiment_ids_value1", "experiment_ids_value2"], + "recommendation_token": "recommendation_token_value", + "event_attributes": {"categorical_features": {}, "numerical_features": {}}, + }, + "product_event_detail": { + "search_query": "search_query_value", + "page_categories": [ + {"categories": ["categories_value1", "categories_value2"]} + ], + "product_details": [ + { + "id": "id_value", + "currency_code": "currency_code_value", + "original_price": 0.1479, + "display_price": 0.1384, + "stock_state": 1, + "quantity": 895, + "available_quantity": 1919, + "item_attributes": {}, + } + ], + "list_id": "list_id_value", + "cart_id": "cart_id_value", + "purchase_transaction": { + "id": "id_value", + "revenue": 0.762, + "taxes": {}, + "costs": {}, + "currency_code": "currency_code_value", + }, + }, + "event_time": {"seconds": 751, "nanos": 543}, + "event_source": 1, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.UserEventServiceGrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.write_user_event(request) + + +def test_write_user_event_rest_flattened(): + client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.UserEventServiceGrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = gcr_user_event.UserEvent() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + user_event=gcr_user_event.UserEvent(event_type="event_type_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = gcr_user_event.UserEvent.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.write_user_event(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:write" + % client.transport._host, + args[1], + ) + + +def test_write_user_event_rest_flattened_error(transport: str = "rest"): + client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.write_user_event( + user_event_service.WriteUserEventRequest(), + parent="parent_value", + user_event=gcr_user_event.UserEvent(event_type="event_type_value"), + ) -@pytest.mark.parametrize( - "transport_class", - [ - transports.UserEventServiceGrpcTransport, - transports.UserEventServiceGrpcAsyncIOTransport, - ], -) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, "default") as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() +def test_write_user_event_rest_error(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + user_event_service.CollectUserEventRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = UserEventServiceClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. +def test_collect_user_event_rest(request_type): client = UserEventServiceClient( credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.UserEventServiceGrpcTransport, + transport="rest", ) + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) -def test_user_event_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.UserEventServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json", + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = httpbody_pb2.HttpBody( + content_type="content_type_value", + data=b"data_blob", ) + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = return_value + json_return_value = json_format.MessageToJson(pb_return_value) -def test_user_event_service_base_transport(): - # Instantiate the base transport. - with mock.patch( - "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport.__init__" - ) as Transport: - Transport.return_value = None - transport = transports.UserEventServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.collect_user_event(request) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "write_user_event", - "collect_user_event", - "list_user_events", - "purge_user_events", - "import_user_events", + # Establish that the response is the type that we expect. + assert isinstance(response, httpbody_pb2.HttpBody) + assert response.content_type == "content_type_value" + assert response.data == b"data_blob" + + +def test_collect_user_event_rest_required_fields( + request_type=user_event_service.CollectUserEventRequest, +): + transport_class = transports.UserEventServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["user_event"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # verify fields with default values are dropped + assert "userEvent" not in jsonified_request - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).collect_user_event._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # verify required fields with default values are now present + assert "userEvent" in jsonified_request + assert jsonified_request["userEvent"] == request_init["user_event"] + jsonified_request["parent"] = "parent_value" + jsonified_request["userEvent"] = "user_event_value" -def test_user_event_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch( - "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport._prep_wrapped_messages" - ) as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.UserEventServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with( - "credentials.json", - scopes=None, - default_scopes=("https://www.googleapis.com/auth/cloud-platform",), - quota_project_id="octopus", + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).collect_user_event._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "ets", + "uri", + "user_event", ) + ) + jsonified_request.update(unset_fields) + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + assert "userEvent" in jsonified_request + assert jsonified_request["userEvent"] == "user_event_value" -def test_user_event_service_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( - "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport._prep_wrapped_messages" + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = httpbody_pb2.HttpBody() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = return_value + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.collect_user_event(request) + + expected_params = [ + ( + "userEvent", + "", + ), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_collect_user_event_rest_unset_required_fields(): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.collect_user_event._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "ets", + "uri", + "userEvent", + ) + ) + & set( + ( + "parent", + "userEvent", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_collect_user_event_rest_interceptors(null_interceptor): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.UserEventServiceRestInterceptor(), + ) + client = UserEventServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.UserEventServiceRestInterceptor, "post_collect_user_event" + ) as post, mock.patch.object( + transports.UserEventServiceRestInterceptor, "pre_collect_user_event" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = user_event_service.CollectUserEventRequest.pb( + user_event_service.CollectUserEventRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson(httpbody_pb2.HttpBody()) + + request = user_event_service.CollectUserEventRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = httpbody_pb2.HttpBody() + + client.collect_user_event( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_collect_user_event_rest_bad_request( + transport: str = "rest", request_type=user_event_service.CollectUserEventRequest +): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.collect_user_event(request) + + +def test_collect_user_event_rest_flattened(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = httpbody_pb2.HttpBody() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + user_event="user_event_value", + uri="uri_value", + ets=332, + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = return_value + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.collect_user_event(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:collect" + % client.transport._host, + args[1], + ) + + +def test_collect_user_event_rest_flattened_error(transport: str = "rest"): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.collect_user_event( + user_event_service.CollectUserEventRequest(), + parent="parent_value", + user_event="user_event_value", + uri="uri_value", + ets=332, + ) + + +def test_collect_user_event_rest_error(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + user_event_service.ListUserEventsRequest, + dict, + ], +) +def test_list_user_events_rest(request_type): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = user_event_service.ListUserEventsResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = user_event_service.ListUserEventsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_user_events(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListUserEventsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_user_events_rest_required_fields( + request_type=user_event_service.ListUserEventsRequest, +): + transport_class = transports.UserEventServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_user_events._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_user_events._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = user_event_service.ListUserEventsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = user_event_service.ListUserEventsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_user_events(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_user_events_rest_unset_required_fields(): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_user_events._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_user_events_rest_interceptors(null_interceptor): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.UserEventServiceRestInterceptor(), + ) + client = UserEventServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.UserEventServiceRestInterceptor, "post_list_user_events" + ) as post, mock.patch.object( + transports.UserEventServiceRestInterceptor, "pre_list_user_events" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = user_event_service.ListUserEventsRequest.pb( + user_event_service.ListUserEventsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = user_event_service.ListUserEventsResponse.to_json( + user_event_service.ListUserEventsResponse() + ) + + request = user_event_service.ListUserEventsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = user_event_service.ListUserEventsResponse() + + client.list_user_events( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_user_events_rest_bad_request( + transport: str = "rest", request_type=user_event_service.ListUserEventsRequest +): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_user_events(request) + + +def test_list_user_events_rest_flattened(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = user_event_service.ListUserEventsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + filter="filter_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = user_event_service.ListUserEventsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_user_events(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents" + % client.transport._host, + args[1], + ) + + +def test_list_user_events_rest_flattened_error(transport: str = "rest"): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_user_events( + user_event_service.ListUserEventsRequest(), + parent="parent_value", + filter="filter_value", + ) + + +def test_list_user_events_rest_pager(transport: str = "rest"): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + user_event_service.ListUserEventsResponse( + user_events=[ + user_event.UserEvent(), + user_event.UserEvent(), + user_event.UserEvent(), + ], + next_page_token="abc", + ), + user_event_service.ListUserEventsResponse( + user_events=[], + next_page_token="def", + ), + user_event_service.ListUserEventsResponse( + user_events=[ + user_event.UserEvent(), + ], + next_page_token="ghi", + ), + user_event_service.ListUserEventsResponse( + user_events=[ + user_event.UserEvent(), + user_event.UserEvent(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + user_event_service.ListUserEventsResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + pager = client.list_user_events(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, user_event.UserEvent) for i in results) + + pages = list(client.list_user_events(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + user_event_service.PurgeUserEventsRequest, + dict, + ], +) +def test_purge_user_events_rest(request_type): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.purge_user_events(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_purge_user_events_rest_required_fields( + request_type=user_event_service.PurgeUserEventsRequest, +): + transport_class = transports.UserEventServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request_init["filter"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_user_events._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + jsonified_request["filter"] = "filter_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).purge_user_events._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + assert "filter" in jsonified_request + assert jsonified_request["filter"] == "filter_value" + + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.purge_user_events(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_purge_user_events_rest_unset_required_fields(): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.purge_user_events._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "filter", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_purge_user_events_rest_interceptors(null_interceptor): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.UserEventServiceRestInterceptor(), + ) + client = UserEventServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.UserEventServiceRestInterceptor, "post_purge_user_events" + ) as post, mock.patch.object( + transports.UserEventServiceRestInterceptor, "pre_purge_user_events" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = user_event_service.PurgeUserEventsRequest.pb( + user_event_service.PurgeUserEventsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = user_event_service.PurgeUserEventsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.purge_user_events( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_purge_user_events_rest_bad_request( + transport: str = "rest", request_type=user_event_service.PurgeUserEventsRequest +): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.purge_user_events(request) + + +def test_purge_user_events_rest_flattened(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + filter="filter_value", + force=True, + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.purge_user_events(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:purge" + % client.transport._host, + args[1], + ) + + +def test_purge_user_events_rest_flattened_error(transport: str = "rest"): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.purge_user_events( + user_event_service.PurgeUserEventsRequest(), + parent="parent_value", + filter="filter_value", + force=True, + ) + + +def test_purge_user_events_rest_error(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + import_.ImportUserEventsRequest, + dict, + ], +) +def test_import_user_events_rest(request_type): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.import_user_events(request) + + # Establish that the response is the type that we expect. + assert response.operation.name == "operations/spam" + + +def test_import_user_events_rest_required_fields( + request_type=import_.ImportUserEventsRequest, +): + transport_class = transports.UserEventServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_user_events._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).import_user_events._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.import_user_events(request) + + expected_params = [] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_import_user_events_rest_unset_required_fields(): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.import_user_events._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "inputConfig", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_user_events_rest_interceptors(null_interceptor): + transport = transports.UserEventServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.UserEventServiceRestInterceptor(), + ) + client = UserEventServiceClient(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + operation.Operation, "_set_result_from_operation" + ), mock.patch.object( + transports.UserEventServiceRestInterceptor, "post_import_user_events" + ) as post, mock.patch.object( + transports.UserEventServiceRestInterceptor, "pre_import_user_events" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = import_.ImportUserEventsRequest.pb( + import_.ImportUserEventsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = json_format.MessageToJson( + operations_pb2.Operation() + ) + + request = import_.ImportUserEventsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = operations_pb2.Operation() + + client.import_user_events( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_user_events_rest_bad_request( + transport: str = "rest", request_type=import_.ImportUserEventsRequest +): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.import_user_events(request) + + +def test_import_user_events_rest_flattened(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation(name="operations/spam") + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/catalogs/sample3/eventStores/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + request_id="request_id_value", + input_config=import_.InputConfig( + catalog_inline_source=import_.CatalogInlineSource( + catalog_items=[catalog.CatalogItem(id="id_value")] + ) + ), + errors_config=import_.ImportErrorsConfig(gcs_prefix="gcs_prefix_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.import_user_events(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:import" + % client.transport._host, + args[1], + ) + + +def test_import_user_events_rest_flattened_error(transport: str = "rest"): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.import_user_events( + import_.ImportUserEventsRequest(), + parent="parent_value", + request_id="request_id_value", + input_config=import_.InputConfig( + catalog_inline_source=import_.CatalogInlineSource( + catalog_items=[catalog.CatalogItem(id="id_value")] + ) + ), + errors_config=import_.ImportErrorsConfig(gcs_prefix="gcs_prefix_value"), + ) + + +def test_import_user_events_rest_error(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = UserEventServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = UserEventServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = UserEventServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = UserEventServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = UserEventServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.UserEventServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.UserEventServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.UserEventServiceGrpcTransport, + transports.UserEventServiceGrpcAsyncIOTransport, + transports.UserEventServiceRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = UserEventServiceClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.UserEventServiceGrpcTransport, + ) + + +def test_user_event_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.UserEventServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_user_event_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.UserEventServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "write_user_event", + "collect_user_event", + "list_user_events", + "purge_user_events", + "import_user_events", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_user_event_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.UserEventServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_user_event_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.recommendationengine_v1beta1.services.user_event_service.transports.UserEventServiceTransport._prep_wrapped_messages" ) as Transport: Transport.return_value = None adc.return_value = (ga_credentials.AnonymousCredentials(), None) @@ -2461,6 +4127,7 @@ def test_user_event_service_transport_auth_adc(transport_class): [ transports.UserEventServiceGrpcTransport, transports.UserEventServiceGrpcAsyncIOTransport, + transports.UserEventServiceRestTransport, ], ) def test_user_event_service_transport_auth_gdch_credentials(transport_class): @@ -2558,11 +4225,40 @@ def test_user_event_service_grpc_transport_client_cert_source_for_mtls(transport ) +def test_user_event_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.UserEventServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +def test_user_event_service_rest_lro_client(): + client = UserEventServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.AbstractOperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_user_event_service_host_no_port(transport_name): @@ -2573,7 +4269,11 @@ def test_user_event_service_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:443") + assert client.transport._host == ( + "recommendationengine.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com" + ) @pytest.mark.parametrize( @@ -2581,6 +4281,7 @@ def test_user_event_service_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_user_event_service_host_with_port(transport_name): @@ -2591,7 +4292,45 @@ def test_user_event_service_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("recommendationengine.googleapis.com:8000") + assert client.transport._host == ( + "recommendationengine.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://recommendationengine.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_user_event_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = UserEventServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = UserEventServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.write_user_event._session + session2 = client2.transport.write_user_event._session + assert session1 != session2 + session1 = client1.transport.collect_user_event._session + session2 = client2.transport.collect_user_event._session + assert session1 != session2 + session1 = client1.transport.list_user_events._session + session2 = client2.transport.list_user_events._session + assert session1 != session2 + session1 = client1.transport.purge_user_events._session + session2 = client2.transport.purge_user_events._session + assert session1 != session2 + session1 = client1.transport.import_user_events._session + session2 = client2.transport.import_user_events._session + assert session1 != session2 def test_user_event_service_grpc_transport_channel(): @@ -2927,6 +4666,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2944,6 +4684,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: