diff --git a/.repo-metadata.json b/.repo-metadata.json index 42b6d7d..6201747 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -4,7 +4,7 @@ "product_documentation": "https://cloud.google.com/network-connectivity/", "client_documentation": "https://googleapis.dev/python/networkconnectivity/latest", "issue_tracker": "", - "release_level": "alpha", + "release_level": "beta", "language": "python", "library_type": "GAPIC_AUTO", "repo": "googleapis/python-network-connectivity", diff --git a/README.rst b/README.rst index 3cd1205..06e48b1 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Python Client for Network Connectivity Center ================================================= -|alpha| |pypi| |versions| +|beta| |pypi| |versions| `Network Connectivity Center`_: The Network Connectivity API will be home to various services which provide information pertaining to network connectivity. @@ -13,8 +13,8 @@ inconsistencies, etc. - `Client Library Documentation`_ - `Product Documentation`_ -.. |alpha| image:: https://img.shields.io/badge/support-alpha-orange.svg - :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#alpha-support +.. |beta| image:: https://img.shields.io/badge/support-alpha-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-network-connectivity.svg :target: https://pypi.org/project/google-cloud-network-connectivity/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-network-connectivity.svg diff --git a/docs/index.rst b/docs/index.rst index ccd6a91..55e2a45 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,18 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of ``google-cloud-network-connectivity``. +By default, you will get version ``v1``. + +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + networkconnectivity_v1/services + networkconnectivity_v1/types + + API Reference ------------- .. toctree:: diff --git a/docs/networkconnectivity_v1/hub_service.rst b/docs/networkconnectivity_v1/hub_service.rst new file mode 100644 index 0000000..7dbce3d --- /dev/null +++ b/docs/networkconnectivity_v1/hub_service.rst @@ -0,0 +1,10 @@ +HubService +---------------------------- + +.. automodule:: google.cloud.networkconnectivity_v1.services.hub_service + :members: + :inherited-members: + +.. automodule:: google.cloud.networkconnectivity_v1.services.hub_service.pagers + :members: + :inherited-members: diff --git a/docs/networkconnectivity_v1/services.rst b/docs/networkconnectivity_v1/services.rst new file mode 100644 index 0000000..a3f383d --- /dev/null +++ b/docs/networkconnectivity_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Networkconnectivity v1 API +==================================================== +.. toctree:: + :maxdepth: 2 + + hub_service diff --git a/docs/networkconnectivity_v1/types.rst b/docs/networkconnectivity_v1/types.rst new file mode 100644 index 0000000..642ecb4 --- /dev/null +++ b/docs/networkconnectivity_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Networkconnectivity v1 API +================================================= + +.. automodule:: google.cloud.networkconnectivity_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/google/cloud/networkconnectivity/__init__.py b/google/cloud/networkconnectivity/__init__.py index 7bef408..efa2753 100644 --- a/google/cloud/networkconnectivity/__init__.py +++ b/google/cloud/networkconnectivity/__init__.py @@ -14,42 +14,52 @@ # limitations under the License. # -from google.cloud.networkconnectivity_v1alpha1.services.hub_service.client import ( +from google.cloud.networkconnectivity_v1.services.hub_service.client import ( HubServiceClient, ) -from google.cloud.networkconnectivity_v1alpha1.services.hub_service.async_client import ( +from google.cloud.networkconnectivity_v1.services.hub_service.async_client import ( HubServiceAsyncClient, ) -from google.cloud.networkconnectivity_v1alpha1.types.common import OperationMetadata -from google.cloud.networkconnectivity_v1alpha1.types.hub import CreateHubRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import CreateSpokeRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import DeleteHubRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import DeleteSpokeRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import GetHubRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import GetSpokeRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import Hub -from google.cloud.networkconnectivity_v1alpha1.types.hub import ListHubsRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import ListHubsResponse -from google.cloud.networkconnectivity_v1alpha1.types.hub import ListSpokesRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import ListSpokesResponse -from google.cloud.networkconnectivity_v1alpha1.types.hub import RouterApplianceInstance -from google.cloud.networkconnectivity_v1alpha1.types.hub import Spoke -from google.cloud.networkconnectivity_v1alpha1.types.hub import UpdateHubRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import UpdateSpokeRequest -from google.cloud.networkconnectivity_v1alpha1.types.hub import State +from google.cloud.networkconnectivity_v1.types.common import OperationMetadata +from google.cloud.networkconnectivity_v1.types.hub import ActivateSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import CreateHubRequest +from google.cloud.networkconnectivity_v1.types.hub import CreateSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import DeactivateSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import DeleteHubRequest +from google.cloud.networkconnectivity_v1.types.hub import DeleteSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import GetHubRequest +from google.cloud.networkconnectivity_v1.types.hub import GetSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import Hub +from google.cloud.networkconnectivity_v1.types.hub import LinkedInterconnectAttachments +from google.cloud.networkconnectivity_v1.types.hub import LinkedRouterApplianceInstances +from google.cloud.networkconnectivity_v1.types.hub import LinkedVpnTunnels +from google.cloud.networkconnectivity_v1.types.hub import ListHubsRequest +from google.cloud.networkconnectivity_v1.types.hub import ListHubsResponse +from google.cloud.networkconnectivity_v1.types.hub import ListSpokesRequest +from google.cloud.networkconnectivity_v1.types.hub import ListSpokesResponse +from google.cloud.networkconnectivity_v1.types.hub import RouterApplianceInstance +from google.cloud.networkconnectivity_v1.types.hub import Spoke +from google.cloud.networkconnectivity_v1.types.hub import UpdateHubRequest +from google.cloud.networkconnectivity_v1.types.hub import UpdateSpokeRequest +from google.cloud.networkconnectivity_v1.types.hub import State __all__ = ( "HubServiceClient", "HubServiceAsyncClient", "OperationMetadata", + "ActivateSpokeRequest", "CreateHubRequest", "CreateSpokeRequest", + "DeactivateSpokeRequest", "DeleteHubRequest", "DeleteSpokeRequest", "GetHubRequest", "GetSpokeRequest", "Hub", + "LinkedInterconnectAttachments", + "LinkedRouterApplianceInstances", + "LinkedVpnTunnels", "ListHubsRequest", "ListHubsResponse", "ListSpokesRequest", diff --git a/google/cloud/networkconnectivity/py.typed b/google/cloud/networkconnectivity/py.typed index cf23681..e8bf4d0 100644 --- a/google/cloud/networkconnectivity/py.typed +++ b/google/cloud/networkconnectivity/py.typed @@ -1,2 +1,2 @@ # Marker file for PEP 561. -# The google-cloud-network-connectivity package uses inline types. +# The google-cloud-networkconnectivity package uses inline types. diff --git a/google/cloud/networkconnectivity_v1/__init__.py b/google/cloud/networkconnectivity_v1/__init__.py new file mode 100644 index 0000000..5d13503 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 .services.hub_service import HubServiceClient +from .services.hub_service import HubServiceAsyncClient + +from .types.common import OperationMetadata +from .types.hub import ActivateSpokeRequest +from .types.hub import CreateHubRequest +from .types.hub import CreateSpokeRequest +from .types.hub import DeactivateSpokeRequest +from .types.hub import DeleteHubRequest +from .types.hub import DeleteSpokeRequest +from .types.hub import GetHubRequest +from .types.hub import GetSpokeRequest +from .types.hub import Hub +from .types.hub import LinkedInterconnectAttachments +from .types.hub import LinkedRouterApplianceInstances +from .types.hub import LinkedVpnTunnels +from .types.hub import ListHubsRequest +from .types.hub import ListHubsResponse +from .types.hub import ListSpokesRequest +from .types.hub import ListSpokesResponse +from .types.hub import RouterApplianceInstance +from .types.hub import Spoke +from .types.hub import UpdateHubRequest +from .types.hub import UpdateSpokeRequest +from .types.hub import State + +__all__ = ( + "HubServiceAsyncClient", + "ActivateSpokeRequest", + "CreateHubRequest", + "CreateSpokeRequest", + "DeactivateSpokeRequest", + "DeleteHubRequest", + "DeleteSpokeRequest", + "GetHubRequest", + "GetSpokeRequest", + "Hub", + "HubServiceClient", + "LinkedInterconnectAttachments", + "LinkedRouterApplianceInstances", + "LinkedVpnTunnels", + "ListHubsRequest", + "ListHubsResponse", + "ListSpokesRequest", + "ListSpokesResponse", + "OperationMetadata", + "RouterApplianceInstance", + "Spoke", + "State", + "UpdateHubRequest", + "UpdateSpokeRequest", +) diff --git a/google/cloud/networkconnectivity_v1/gapic_metadata.json b/google/cloud/networkconnectivity_v1/gapic_metadata.json new file mode 100644 index 0000000..b47970f --- /dev/null +++ b/google/cloud/networkconnectivity_v1/gapic_metadata.json @@ -0,0 +1,143 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.networkconnectivity_v1", + "protoPackage": "google.cloud.networkconnectivity.v1", + "schema": "1.0", + "services": { + "HubService": { + "clients": { + "grpc": { + "libraryClient": "HubServiceClient", + "rpcs": { + "ActivateSpoke": { + "methods": [ + "activate_spoke" + ] + }, + "CreateHub": { + "methods": [ + "create_hub" + ] + }, + "CreateSpoke": { + "methods": [ + "create_spoke" + ] + }, + "DeactivateSpoke": { + "methods": [ + "deactivate_spoke" + ] + }, + "DeleteHub": { + "methods": [ + "delete_hub" + ] + }, + "DeleteSpoke": { + "methods": [ + "delete_spoke" + ] + }, + "GetHub": { + "methods": [ + "get_hub" + ] + }, + "GetSpoke": { + "methods": [ + "get_spoke" + ] + }, + "ListHubs": { + "methods": [ + "list_hubs" + ] + }, + "ListSpokes": { + "methods": [ + "list_spokes" + ] + }, + "UpdateHub": { + "methods": [ + "update_hub" + ] + }, + "UpdateSpoke": { + "methods": [ + "update_spoke" + ] + } + } + }, + "grpc-async": { + "libraryClient": "HubServiceAsyncClient", + "rpcs": { + "ActivateSpoke": { + "methods": [ + "activate_spoke" + ] + }, + "CreateHub": { + "methods": [ + "create_hub" + ] + }, + "CreateSpoke": { + "methods": [ + "create_spoke" + ] + }, + "DeactivateSpoke": { + "methods": [ + "deactivate_spoke" + ] + }, + "DeleteHub": { + "methods": [ + "delete_hub" + ] + }, + "DeleteSpoke": { + "methods": [ + "delete_spoke" + ] + }, + "GetHub": { + "methods": [ + "get_hub" + ] + }, + "GetSpoke": { + "methods": [ + "get_spoke" + ] + }, + "ListHubs": { + "methods": [ + "list_hubs" + ] + }, + "ListSpokes": { + "methods": [ + "list_spokes" + ] + }, + "UpdateHub": { + "methods": [ + "update_hub" + ] + }, + "UpdateSpoke": { + "methods": [ + "update_spoke" + ] + } + } + } + } + } + } +} diff --git a/google/cloud/networkconnectivity_v1/py.typed b/google/cloud/networkconnectivity_v1/py.typed new file mode 100644 index 0000000..e8bf4d0 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-networkconnectivity package uses inline types. diff --git a/google/cloud/networkconnectivity_v1/services/__init__.py b/google/cloud/networkconnectivity_v1/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/__init__.py b/google/cloud/networkconnectivity_v1/services/hub_service/__init__.py new file mode 100644 index 0000000..b464df6 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 .client import HubServiceClient +from .async_client import HubServiceAsyncClient + +__all__ = ( + "HubServiceClient", + "HubServiceAsyncClient", +) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/async_client.py b/google/cloud/networkconnectivity_v1/services/hub_service/async_client.py new file mode 100644 index 0000000..3992c8a --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/async_client.py @@ -0,0 +1,1288 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.networkconnectivity_v1.services.hub_service import pagers +from google.cloud.networkconnectivity_v1.types import common +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import HubServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import HubServiceGrpcAsyncIOTransport +from .client import HubServiceClient + + +class HubServiceAsyncClient: + """Network Connectivity Center is a hub-and-spoke abstraction + for network connectivity management in Google Cloud. It reduces + operational complexity through a simple, centralized + connectivity management model. + """ + + _client: HubServiceClient + + DEFAULT_ENDPOINT = HubServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = HubServiceClient.DEFAULT_MTLS_ENDPOINT + + hub_path = staticmethod(HubServiceClient.hub_path) + parse_hub_path = staticmethod(HubServiceClient.parse_hub_path) + instance_path = staticmethod(HubServiceClient.instance_path) + parse_instance_path = staticmethod(HubServiceClient.parse_instance_path) + interconnect_attachment_path = staticmethod( + HubServiceClient.interconnect_attachment_path + ) + parse_interconnect_attachment_path = staticmethod( + HubServiceClient.parse_interconnect_attachment_path + ) + spoke_path = staticmethod(HubServiceClient.spoke_path) + parse_spoke_path = staticmethod(HubServiceClient.parse_spoke_path) + vpn_tunnel_path = staticmethod(HubServiceClient.vpn_tunnel_path) + parse_vpn_tunnel_path = staticmethod(HubServiceClient.parse_vpn_tunnel_path) + common_billing_account_path = staticmethod( + HubServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + HubServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(HubServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(HubServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(HubServiceClient.common_organization_path) + parse_common_organization_path = staticmethod( + HubServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(HubServiceClient.common_project_path) + parse_common_project_path = staticmethod(HubServiceClient.parse_common_project_path) + common_location_path = staticmethod(HubServiceClient.common_location_path) + parse_common_location_path = staticmethod( + HubServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + HubServiceAsyncClient: The constructed client. + """ + return HubServiceClient.from_service_account_info.__func__(HubServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + HubServiceAsyncClient: The constructed client. + """ + return HubServiceClient.from_service_account_file.__func__(HubServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> HubServiceTransport: + """Returns the transport used by the client instance. + + Returns: + HubServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial( + type(HubServiceClient).get_transport_class, type(HubServiceClient) + ) + + def __init__( + self, + *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, HubServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the hub service client. + + Args: + 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. + transport (Union[str, ~.HubServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + 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 + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = HubServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + async def list_hubs( + self, + request: hub.ListHubsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListHubsAsyncPager: + r"""Lists hubs in a given project. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.ListHubsRequest`): + The request object. Request for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + parent (:class:`str`): + Required. The parent resource's name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListHubsAsyncPager: + Response for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.ListHubsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_hubs, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListHubsAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_hub( + self, + request: hub.GetHubRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> hub.Hub: + r"""Gets details about the specified hub. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.GetHubRequest`): + The request object. Request for + [HubService.GetHub][google.cloud.networkconnectivity.v1.HubService.GetHub] + method. + name (:class:`str`): + Required. The name of the hub + resource to get. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.types.Hub: + A hub is essentially a collection of + spokes. A single hub can contain spokes + from multiple regions. However, all of a + hub's spokes must be associated with + resources that reside in the same VPC + network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.GetHubRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_hub, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def create_hub( + self, + request: gcn_hub.CreateHubRequest = None, + *, + parent: str = None, + hub: gcn_hub.Hub = None, + hub_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a new hub in the specified project. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.CreateHubRequest`): + The request object. Request for + [HubService.CreateHub][google.cloud.networkconnectivity.v1.HubService.CreateHub] + method. + parent (:class:`str`): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hub (:class:`google.cloud.networkconnectivity_v1.types.Hub`): + Required. The initial values for a + new hub. + + This corresponds to the ``hub`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hub_id (:class:`str`): + Optional. A unique identifier for the + hub. + + This corresponds to the ``hub_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Hub` A hub is essentially a collection of spokes. A single hub can contain spokes + from multiple regions. However, all of a hub's spokes + must be associated with resources that reside in the + same VPC network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, hub, hub_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = gcn_hub.CreateHubRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if hub is not None: + request.hub = hub + if hub_id is not None: + request.hub_id = hub_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_hub, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + gcn_hub.Hub, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_hub( + self, + request: gcn_hub.UpdateHubRequest = None, + *, + hub: gcn_hub.Hub = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the description and/or labels of the + specified hub. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.UpdateHubRequest`): + The request object. Request for + [HubService.UpdateHub][google.cloud.networkconnectivity.v1.HubService.UpdateHub] + method. + hub (:class:`google.cloud.networkconnectivity_v1.types.Hub`): + Required. The state that the hub + should be in after the update. + + This corresponds to the ``hub`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. In the case of an update to an existing hub, + field mask is used to specify the fields to be + overwritten. The fields specified in the update_mask are + relative to the resource, not the full request. A field + is overwritten if it is in the mask. If the user does + not provide a mask, then all fields are overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Hub` A hub is essentially a collection of spokes. A single hub can contain spokes + from multiple regions. However, all of a hub's spokes + must be associated with resources that reside in the + same VPC network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([hub, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = gcn_hub.UpdateHubRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if hub is not None: + request.hub = hub + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_hub, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("hub.name", request.hub.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + gcn_hub.Hub, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_hub( + self, + request: hub.DeleteHubRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the specified hub. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.DeleteHubRequest`): + The request object. The request for + [HubService.DeleteHub][google.cloud.networkconnectivity.v1.HubService.DeleteHub]. + name (:class:`str`): + Required. The name of the hub to + delete. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.DeleteHubRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_hub, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_spokes( + self, + request: hub.ListSpokesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSpokesAsyncPager: + r"""Lists the spokes in the specified project and + location. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.ListSpokesRequest`): + The request object. The request for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + parent (:class:`str`): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListSpokesAsyncPager: + The response for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.ListSpokesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_spokes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListSpokesAsyncPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_spoke( + self, + request: hub.GetSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> hub.Spoke: + r"""Gets details about the specified spoke. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.GetSpokeRequest`): + The request object. The request for + [HubService.GetSpoke][google.cloud.networkconnectivity.v1.HubService.GetSpoke]. + name (:class:`str`): + Required. The name of the spoke + resource. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.types.Spoke: + A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.GetSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_spoke, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + async def create_spoke( + self, + request: hub.CreateSpokeRequest = None, + *, + parent: str = None, + spoke: hub.Spoke = None, + spoke_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a spoke in the specified project and + location. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.CreateSpokeRequest`): + The request object. The request for + [HubService.CreateSpoke][google.cloud.networkconnectivity.v1.HubService.CreateSpoke]. + parent (:class:`str`): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + spoke (:class:`google.cloud.networkconnectivity_v1.types.Spoke`): + Required. The initial values for a + new spoke. + + This corresponds to the ``spoke`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + spoke_id (:class:`str`): + Optional. Unique id for the spoke to + create. + + This corresponds to the ``spoke_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, spoke, spoke_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.CreateSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if spoke is not None: + request.spoke = spoke + if spoke_id is not None: + request.spoke_id = spoke_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_spoke, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def update_spoke( + self, + request: hub.UpdateSpokeRequest = None, + *, + spoke: hub.Spoke = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the parameters of the specified spoke. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.UpdateSpokeRequest`): + The request object. Request for + [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1.HubService.UpdateSpoke] + method. + spoke (:class:`google.cloud.networkconnectivity_v1.types.Spoke`): + Required. The state that the spoke + should be in after the update. + + This corresponds to the ``spoke`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. In the case of an update to an existing spoke, + field mask is used to specify the fields to be + overwritten. The fields specified in the update_mask are + relative to the resource, not the full request. A field + is overwritten if it is in the mask. If the user does + not provide a mask, then all fields are overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([spoke, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.UpdateSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if spoke is not None: + request.spoke = spoke + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_spoke, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("spoke.name", request.spoke.name),) + ), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def deactivate_spoke( + self, + request: hub.DeactivateSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deactivates the specified spoke. Deactivating keeps + the spoke information for future re-activation, but + disconnects the Google Cloud network from non-Google- + Cloud network. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.DeactivateSpokeRequest`): + The request object. The request for + [HubService.DeactivateSpoke][google.cloud.networkconnectivity.v1.HubService.DeactivateSpoke]. + name (:class:`str`): + Required. The name of the spoke to + deactivate. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.DeactivateSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.deactivate_spoke, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def activate_spoke( + self, + request: hub.ActivateSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Activates the specified spoke. Activating reconnects + the Google Cloud network with the non-Google-Cloud + network. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.ActivateSpokeRequest`): + The request object. The request for + [HubService.ActivateSpoke][google.cloud.networkconnectivity.v1.HubService.ActivateSpoke]. + name (:class:`str`): + Required. The name of the spoke to + activate. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.ActivateSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.activate_spoke, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_spoke( + self, + request: hub.DeleteSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the specified spoke. + + Args: + request (:class:`google.cloud.networkconnectivity_v1.types.DeleteSpokeRequest`): + The request object. The request for + [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1.HubService.DeleteSpoke]. + name (:class:`str`): + Required. The name of the spoke to + delete. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = hub.DeleteSpokeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_spoke, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + empty_pb2.Empty, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-networkconnectivity", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("HubServiceAsyncClient",) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/client.py b/google/cloud/networkconnectivity_v1/services/hub_service/client.py new file mode 100644 index 0000000..e11b84d --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/client.py @@ -0,0 +1,1534 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.networkconnectivity_v1.services.hub_service import pagers +from google.cloud.networkconnectivity_v1.types import common +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.protobuf import empty_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import HubServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import HubServiceGrpcTransport +from .transports.grpc_asyncio import HubServiceGrpcAsyncIOTransport + + +class HubServiceClientMeta(type): + """Metaclass for the HubService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = OrderedDict() # type: Dict[str, Type[HubServiceTransport]] + _transport_registry["grpc"] = HubServiceGrpcTransport + _transport_registry["grpc_asyncio"] = HubServiceGrpcAsyncIOTransport + + def get_transport_class(cls, label: str = None,) -> Type[HubServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class HubServiceClient(metaclass=HubServiceClientMeta): + """Network Connectivity Center is a hub-and-spoke abstraction + for network connectivity management in Google Cloud. It reduces + operational complexity through a simple, centralized + connectivity management model. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "networkconnectivity.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + HubServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + HubServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> HubServiceTransport: + """Returns the transport used by the client instance. + + Returns: + HubServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def hub_path(project: str, hub: str,) -> str: + """Returns a fully-qualified hub string.""" + return "projects/{project}/locations/global/hubs/{hub}".format( + project=project, hub=hub, + ) + + @staticmethod + def parse_hub_path(path: str) -> Dict[str, str]: + """Parses a hub path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/global/hubs/(?P.+?)$", path + ) + return m.groupdict() if m else {} + + @staticmethod + def instance_path(project: str, zone: str, instance: str,) -> str: + """Returns a fully-qualified instance string.""" + return "projects/{project}/zones/{zone}/instances/{instance}".format( + project=project, zone=zone, instance=instance, + ) + + @staticmethod + def parse_instance_path(path: str) -> Dict[str, str]: + """Parses a instance path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/zones/(?P.+?)/instances/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def interconnect_attachment_path( + project: str, region: str, resource_id: str, + ) -> str: + """Returns a fully-qualified interconnect_attachment string.""" + return "projects/{project}/regions/{region}/interconnectAttachments/{resource_id}".format( + project=project, region=region, resource_id=resource_id, + ) + + @staticmethod + def parse_interconnect_attachment_path(path: str) -> Dict[str, str]: + """Parses a interconnect_attachment path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/regions/(?P.+?)/interconnectAttachments/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def spoke_path(project: str, location: str, spoke: str,) -> str: + """Returns a fully-qualified spoke string.""" + return "projects/{project}/locations/{location}/spokes/{spoke}".format( + project=project, location=location, spoke=spoke, + ) + + @staticmethod + def parse_spoke_path(path: str) -> Dict[str, str]: + """Parses a spoke path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/spokes/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def vpn_tunnel_path(project: str, region: str, resource_id: str,) -> str: + """Returns a fully-qualified vpn_tunnel string.""" + return "projects/{project}/regions/{region}/vpnTunnels/{resource_id}".format( + project=project, region=region, resource_id=resource_id, + ) + + @staticmethod + def parse_vpn_tunnel_path(path: str) -> Dict[str, str]: + """Parses a vpn_tunnel path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/regions/(?P.+?)/vpnTunnels/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str,) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str,) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder,) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str,) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization,) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str,) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project,) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str,) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, HubServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the hub service client. + + Args: + 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. + transport (Union[str, HubServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + 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 + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + 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're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool( + util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")) + ) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, HubServiceTransport): + # transport is a HubServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=( + Transport == type(self).get_transport_class("grpc") + or Transport == type(self).get_transport_class("grpc_asyncio") + ), + ) + + def list_hubs( + self, + request: hub.ListHubsRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListHubsPager: + r"""Lists hubs in a given project. + + Args: + request (google.cloud.networkconnectivity_v1.types.ListHubsRequest): + The request object. Request for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + parent (str): + Required. The parent resource's name. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListHubsPager: + Response for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.ListHubsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.ListHubsRequest): + request = hub.ListHubsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_hubs] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListHubsPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def get_hub( + self, + request: hub.GetHubRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> hub.Hub: + r"""Gets details about the specified hub. + + Args: + request (google.cloud.networkconnectivity_v1.types.GetHubRequest): + The request object. Request for + [HubService.GetHub][google.cloud.networkconnectivity.v1.HubService.GetHub] + method. + name (str): + Required. The name of the hub + resource to get. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.types.Hub: + A hub is essentially a collection of + spokes. A single hub can contain spokes + from multiple regions. However, all of a + hub's spokes must be associated with + resources that reside in the same VPC + network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.GetHubRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.GetHubRequest): + request = hub.GetHubRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_hub] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def create_hub( + self, + request: gcn_hub.CreateHubRequest = None, + *, + parent: str = None, + hub: gcn_hub.Hub = None, + hub_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a new hub in the specified project. + + Args: + request (google.cloud.networkconnectivity_v1.types.CreateHubRequest): + The request object. Request for + [HubService.CreateHub][google.cloud.networkconnectivity.v1.HubService.CreateHub] + method. + parent (str): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hub (google.cloud.networkconnectivity_v1.types.Hub): + Required. The initial values for a + new hub. + + This corresponds to the ``hub`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + hub_id (str): + Optional. A unique identifier for the + hub. + + This corresponds to the ``hub_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Hub` A hub is essentially a collection of spokes. A single hub can contain spokes + from multiple regions. However, all of a hub's spokes + must be associated with resources that reside in the + same VPC network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, hub, hub_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a gcn_hub.CreateHubRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, gcn_hub.CreateHubRequest): + request = gcn_hub.CreateHubRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if hub is not None: + request.hub = hub + if hub_id is not None: + request.hub_id = hub_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_hub] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + gcn_hub.Hub, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_hub( + self, + request: gcn_hub.UpdateHubRequest = None, + *, + hub: gcn_hub.Hub = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the description and/or labels of the + specified hub. + + Args: + request (google.cloud.networkconnectivity_v1.types.UpdateHubRequest): + The request object. Request for + [HubService.UpdateHub][google.cloud.networkconnectivity.v1.HubService.UpdateHub] + method. + hub (google.cloud.networkconnectivity_v1.types.Hub): + Required. The state that the hub + should be in after the update. + + This corresponds to the ``hub`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. In the case of an update to an existing hub, + field mask is used to specify the fields to be + overwritten. The fields specified in the update_mask are + relative to the resource, not the full request. A field + is overwritten if it is in the mask. If the user does + not provide a mask, then all fields are overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Hub` A hub is essentially a collection of spokes. A single hub can contain spokes + from multiple regions. However, all of a hub's spokes + must be associated with resources that reside in the + same VPC network. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([hub, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a gcn_hub.UpdateHubRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, gcn_hub.UpdateHubRequest): + request = gcn_hub.UpdateHubRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if hub is not None: + request.hub = hub + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_hub] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("hub.name", request.hub.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + gcn_hub.Hub, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_hub( + self, + request: hub.DeleteHubRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the specified hub. + + Args: + request (google.cloud.networkconnectivity_v1.types.DeleteHubRequest): + The request object. The request for + [HubService.DeleteHub][google.cloud.networkconnectivity.v1.HubService.DeleteHub]. + name (str): + Required. The name of the hub to + delete. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.DeleteHubRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.DeleteHubRequest): + request = hub.DeleteHubRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_hub] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_spokes( + self, + request: hub.ListSpokesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListSpokesPager: + r"""Lists the spokes in the specified project and + location. + + Args: + request (google.cloud.networkconnectivity_v1.types.ListSpokesRequest): + The request object. The request for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + parent (str): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListSpokesPager: + The response for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.ListSpokesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.ListSpokesRequest): + request = hub.ListSpokesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_spokes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListSpokesPager( + method=rpc, request=request, response=response, metadata=metadata, + ) + + # Done; return the response. + return response + + def get_spoke( + self, + request: hub.GetSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> hub.Spoke: + r"""Gets details about the specified spoke. + + Args: + request (google.cloud.networkconnectivity_v1.types.GetSpokeRequest): + The request object. The request for + [HubService.GetSpoke][google.cloud.networkconnectivity.v1.HubService.GetSpoke]. + name (str): + Required. The name of the spoke + resource. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.networkconnectivity_v1.types.Spoke: + A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.GetSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.GetSpokeRequest): + request = hub.GetSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Done; return the response. + return response + + def create_spoke( + self, + request: hub.CreateSpokeRequest = None, + *, + parent: str = None, + spoke: hub.Spoke = None, + spoke_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a spoke in the specified project and + location. + + Args: + request (google.cloud.networkconnectivity_v1.types.CreateSpokeRequest): + The request object. The request for + [HubService.CreateSpoke][google.cloud.networkconnectivity.v1.HubService.CreateSpoke]. + parent (str): + Required. The parent resource. + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + spoke (google.cloud.networkconnectivity_v1.types.Spoke): + Required. The initial values for a + new spoke. + + This corresponds to the ``spoke`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + spoke_id (str): + Optional. Unique id for the spoke to + create. + + This corresponds to the ``spoke_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, spoke, spoke_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.CreateSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.CreateSpokeRequest): + request = hub.CreateSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if spoke is not None: + request.spoke = spoke + if spoke_id is not None: + request.spoke_id = spoke_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def update_spoke( + self, + request: hub.UpdateSpokeRequest = None, + *, + spoke: hub.Spoke = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the parameters of the specified spoke. + + Args: + request (google.cloud.networkconnectivity_v1.types.UpdateSpokeRequest): + The request object. Request for + [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1.HubService.UpdateSpoke] + method. + spoke (google.cloud.networkconnectivity_v1.types.Spoke): + Required. The state that the spoke + should be in after the update. + + This corresponds to the ``spoke`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. In the case of an update to an existing spoke, + field mask is used to specify the fields to be + overwritten. The fields specified in the update_mask are + relative to the resource, not the full request. A field + is overwritten if it is in the mask. If the user does + not provide a mask, then all fields are overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([spoke, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.UpdateSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.UpdateSpokeRequest): + request = hub.UpdateSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if spoke is not None: + request.spoke = spoke + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("spoke.name", request.spoke.name),) + ), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def deactivate_spoke( + self, + request: hub.DeactivateSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deactivates the specified spoke. Deactivating keeps + the spoke information for future re-activation, but + disconnects the Google Cloud network from non-Google- + Cloud network. + + Args: + request (google.cloud.networkconnectivity_v1.types.DeactivateSpokeRequest): + The request object. The request for + [HubService.DeactivateSpoke][google.cloud.networkconnectivity.v1.HubService.DeactivateSpoke]. + name (str): + Required. The name of the spoke to + deactivate. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.DeactivateSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.DeactivateSpokeRequest): + request = hub.DeactivateSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.deactivate_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def activate_spoke( + self, + request: hub.ActivateSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Activates the specified spoke. Activating reconnects + the Google Cloud network with the non-Google-Cloud + network. + + Args: + request (google.cloud.networkconnectivity_v1.types.ActivateSpokeRequest): + The request object. The request for + [HubService.ActivateSpoke][google.cloud.networkconnectivity.v1.HubService.ActivateSpoke]. + name (str): + Required. The name of the spoke to + activate. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.cloud.networkconnectivity_v1.types.Spoke` A spoke represents a connection between your Google Cloud network resources + and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. + You must also identify a value for exactly one of the + following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.ActivateSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.ActivateSpokeRequest): + request = hub.ActivateSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.activate_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + hub.Spoke, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_spoke( + self, + request: hub.DeleteSpokeRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the specified spoke. + + Args: + request (google.cloud.networkconnectivity_v1.types.DeleteSpokeRequest): + The request object. The request for + [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1.HubService.DeleteSpoke]. + name (str): + Required. The name of the spoke to + delete. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to + use it as the request or the response type of an API + method. For instance: + + service Foo { + rpc Bar(google.protobuf.Empty) returns + (google.protobuf.Empty); + + } + + The JSON representation for Empty is empty JSON + object {}. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a hub.DeleteSpokeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, hub.DeleteSpokeRequest): + request = hub.DeleteSpokeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_spoke] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + empty_pb2.Empty, + metadata_type=common.OperationMetadata, + ) + + # Done; return the response. + return response + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-networkconnectivity", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("HubServiceClient",) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/pagers.py b/google/cloud/networkconnectivity_v1/services/hub_service/pagers.py new file mode 100644 index 0000000..58fa5c1 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/pagers.py @@ -0,0 +1,283 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 typing import ( + Any, + AsyncIterable, + Awaitable, + Callable, + Iterable, + Sequence, + Tuple, + Optional, +) + +from google.cloud.networkconnectivity_v1.types import hub + + +class ListHubsPager: + """A pager for iterating through ``list_hubs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.networkconnectivity_v1.types.ListHubsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``hubs`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListHubs`` requests and continue to iterate + through the ``hubs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.networkconnectivity_v1.types.ListHubsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., hub.ListHubsResponse], + request: hub.ListHubsRequest, + response: hub.ListHubsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.networkconnectivity_v1.types.ListHubsRequest): + The initial request object. + response (google.cloud.networkconnectivity_v1.types.ListHubsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = hub.ListHubsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[hub.ListHubsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[hub.Hub]: + for page in self.pages: + yield from page.hubs + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListHubsAsyncPager: + """A pager for iterating through ``list_hubs`` requests. + + This class thinly wraps an initial + :class:`google.cloud.networkconnectivity_v1.types.ListHubsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``hubs`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListHubs`` requests and continue to iterate + through the ``hubs`` field on the + corresponding responses. + + All the usual :class:`google.cloud.networkconnectivity_v1.types.ListHubsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[hub.ListHubsResponse]], + request: hub.ListHubsRequest, + response: hub.ListHubsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.networkconnectivity_v1.types.ListHubsRequest): + The initial request object. + response (google.cloud.networkconnectivity_v1.types.ListHubsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = hub.ListHubsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[hub.ListHubsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[hub.Hub]: + async def async_generator(): + async for page in self.pages: + for response in page.hubs: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListSpokesPager: + """A pager for iterating through ``list_spokes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.networkconnectivity_v1.types.ListSpokesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``spokes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListSpokes`` requests and continue to iterate + through the ``spokes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.networkconnectivity_v1.types.ListSpokesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., hub.ListSpokesResponse], + request: hub.ListSpokesRequest, + response: hub.ListSpokesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.networkconnectivity_v1.types.ListSpokesRequest): + The initial request object. + response (google.cloud.networkconnectivity_v1.types.ListSpokesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = hub.ListSpokesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[hub.ListSpokesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterable[hub.Spoke]: + for page in self.pages: + yield from page.spokes + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListSpokesAsyncPager: + """A pager for iterating through ``list_spokes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.networkconnectivity_v1.types.ListSpokesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``spokes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListSpokes`` requests and continue to iterate + through the ``spokes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.networkconnectivity_v1.types.ListSpokesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[hub.ListSpokesResponse]], + request: hub.ListSpokesRequest, + response: hub.ListSpokesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.networkconnectivity_v1.types.ListSpokesRequest): + The initial request object. + response (google.cloud.networkconnectivity_v1.types.ListSpokesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = hub.ListSpokesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[hub.ListSpokesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterable[hub.Spoke]: + async def async_generator(): + async for page in self.pages: + for response in page.spokes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/transports/__init__.py b/google/cloud/networkconnectivity_v1/services/hub_service/transports/__init__.py new file mode 100644 index 0000000..a384768 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 collections import OrderedDict +from typing import Dict, Type + +from .base import HubServiceTransport +from .grpc import HubServiceGrpcTransport +from .grpc_asyncio import HubServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[HubServiceTransport]] +_transport_registry["grpc"] = HubServiceGrpcTransport +_transport_registry["grpc_asyncio"] = HubServiceGrpcAsyncIOTransport + +__all__ = ( + "HubServiceTransport", + "HubServiceGrpcTransport", + "HubServiceGrpcAsyncIOTransport", +) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/transports/base.py b/google/cloud/networkconnectivity_v1/services/hub_service/transports/base.py new file mode 100644 index 0000000..e885b3c --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/transports/base.py @@ -0,0 +1,306 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-networkconnectivity", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class HubServiceTransport(abc.ABC): + """Abstract transport class for HubService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "networkconnectivity.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + 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 mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + + # If the credentials is service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs( + cls, host: str, scopes: Optional[Sequence[str]] + ) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_hubs: gapic_v1.method.wrap_method( + self.list_hubs, default_timeout=None, client_info=client_info, + ), + self.get_hub: gapic_v1.method.wrap_method( + self.get_hub, default_timeout=None, client_info=client_info, + ), + self.create_hub: gapic_v1.method.wrap_method( + self.create_hub, default_timeout=60.0, client_info=client_info, + ), + self.update_hub: gapic_v1.method.wrap_method( + self.update_hub, default_timeout=60.0, client_info=client_info, + ), + self.delete_hub: gapic_v1.method.wrap_method( + self.delete_hub, default_timeout=60.0, client_info=client_info, + ), + self.list_spokes: gapic_v1.method.wrap_method( + self.list_spokes, default_timeout=None, client_info=client_info, + ), + self.get_spoke: gapic_v1.method.wrap_method( + self.get_spoke, default_timeout=None, client_info=client_info, + ), + self.create_spoke: gapic_v1.method.wrap_method( + self.create_spoke, default_timeout=60.0, client_info=client_info, + ), + self.update_spoke: gapic_v1.method.wrap_method( + self.update_spoke, default_timeout=60.0, client_info=client_info, + ), + self.deactivate_spoke: gapic_v1.method.wrap_method( + self.deactivate_spoke, default_timeout=60.0, client_info=client_info, + ), + self.activate_spoke: gapic_v1.method.wrap_method( + self.activate_spoke, default_timeout=60.0, client_info=client_info, + ), + self.delete_spoke: gapic_v1.method.wrap_method( + self.delete_spoke, default_timeout=60.0, client_info=client_info, + ), + } + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def list_hubs( + self, + ) -> Callable[ + [hub.ListHubsRequest], + Union[hub.ListHubsResponse, Awaitable[hub.ListHubsResponse]], + ]: + raise NotImplementedError() + + @property + def get_hub( + self, + ) -> Callable[[hub.GetHubRequest], Union[hub.Hub, Awaitable[hub.Hub]]]: + raise NotImplementedError() + + @property + def create_hub( + self, + ) -> Callable[ + [gcn_hub.CreateHubRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def update_hub( + self, + ) -> Callable[ + [gcn_hub.UpdateHubRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def delete_hub( + self, + ) -> Callable[ + [hub.DeleteHubRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def list_spokes( + self, + ) -> Callable[ + [hub.ListSpokesRequest], + Union[hub.ListSpokesResponse, Awaitable[hub.ListSpokesResponse]], + ]: + raise NotImplementedError() + + @property + def get_spoke( + self, + ) -> Callable[[hub.GetSpokeRequest], Union[hub.Spoke, Awaitable[hub.Spoke]]]: + raise NotImplementedError() + + @property + def create_spoke( + self, + ) -> Callable[ + [hub.CreateSpokeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def update_spoke( + self, + ) -> Callable[ + [hub.UpdateSpokeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def deactivate_spoke( + self, + ) -> Callable[ + [hub.DeactivateSpokeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def activate_spoke( + self, + ) -> Callable[ + [hub.ActivateSpokeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def delete_spoke( + self, + ) -> Callable[ + [hub.DeleteSpokeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + +__all__ = ("HubServiceTransport",) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc.py b/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc.py new file mode 100644 index 0000000..3b9b38e --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc.py @@ -0,0 +1,560 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.api_core import gapic_v1 # type: ignore +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.longrunning import operations_pb2 # type: ignore +from .base import HubServiceTransport, DEFAULT_CLIENT_INFO + + +class HubServiceGrpcTransport(HubServiceTransport): + """gRPC backend transport for HubService. + + Network Connectivity Center is a hub-and-spoke abstraction + for network connectivity management in Google Cloud. It reduces + operational complexity through a simple, centralized + connectivity management model. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "networkconnectivity.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = 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, + ) -> None: + """Instantiate the transport. + + 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. + This argument is ignored if ``channel`` is provided. + 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. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "networkconnectivity.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this 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 mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient(self.grpc_channel) + + # Return the client from cache. + return self._operations_client + + @property + def list_hubs(self) -> Callable[[hub.ListHubsRequest], hub.ListHubsResponse]: + r"""Return a callable for the list hubs method over gRPC. + + Lists hubs in a given project. + + Returns: + Callable[[~.ListHubsRequest], + ~.ListHubsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_hubs" not in self._stubs: + self._stubs["list_hubs"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ListHubs", + request_serializer=hub.ListHubsRequest.serialize, + response_deserializer=hub.ListHubsResponse.deserialize, + ) + return self._stubs["list_hubs"] + + @property + def get_hub(self) -> Callable[[hub.GetHubRequest], hub.Hub]: + r"""Return a callable for the get hub method over gRPC. + + Gets details about the specified hub. + + Returns: + Callable[[~.GetHubRequest], + ~.Hub]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_hub" not in self._stubs: + self._stubs["get_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/GetHub", + request_serializer=hub.GetHubRequest.serialize, + response_deserializer=hub.Hub.deserialize, + ) + return self._stubs["get_hub"] + + @property + def create_hub( + self, + ) -> Callable[[gcn_hub.CreateHubRequest], operations_pb2.Operation]: + r"""Return a callable for the create hub method over gRPC. + + Creates a new hub in the specified project. + + Returns: + Callable[[~.CreateHubRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_hub" not in self._stubs: + self._stubs["create_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/CreateHub", + request_serializer=gcn_hub.CreateHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_hub"] + + @property + def update_hub( + self, + ) -> Callable[[gcn_hub.UpdateHubRequest], operations_pb2.Operation]: + r"""Return a callable for the update hub method over gRPC. + + Updates the description and/or labels of the + specified hub. + + Returns: + Callable[[~.UpdateHubRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_hub" not in self._stubs: + self._stubs["update_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/UpdateHub", + request_serializer=gcn_hub.UpdateHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_hub"] + + @property + def delete_hub(self) -> Callable[[hub.DeleteHubRequest], operations_pb2.Operation]: + r"""Return a callable for the delete hub method over gRPC. + + Deletes the specified hub. + + Returns: + Callable[[~.DeleteHubRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_hub" not in self._stubs: + self._stubs["delete_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeleteHub", + request_serializer=hub.DeleteHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_hub"] + + @property + def list_spokes(self) -> Callable[[hub.ListSpokesRequest], hub.ListSpokesResponse]: + r"""Return a callable for the list spokes method over gRPC. + + Lists the spokes in the specified project and + location. + + Returns: + Callable[[~.ListSpokesRequest], + ~.ListSpokesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_spokes" not in self._stubs: + self._stubs["list_spokes"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ListSpokes", + request_serializer=hub.ListSpokesRequest.serialize, + response_deserializer=hub.ListSpokesResponse.deserialize, + ) + return self._stubs["list_spokes"] + + @property + def get_spoke(self) -> Callable[[hub.GetSpokeRequest], hub.Spoke]: + r"""Return a callable for the get spoke method over gRPC. + + Gets details about the specified spoke. + + Returns: + Callable[[~.GetSpokeRequest], + ~.Spoke]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_spoke" not in self._stubs: + self._stubs["get_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/GetSpoke", + request_serializer=hub.GetSpokeRequest.serialize, + response_deserializer=hub.Spoke.deserialize, + ) + return self._stubs["get_spoke"] + + @property + def create_spoke( + self, + ) -> Callable[[hub.CreateSpokeRequest], operations_pb2.Operation]: + r"""Return a callable for the create spoke method over gRPC. + + Creates a spoke in the specified project and + location. + + Returns: + Callable[[~.CreateSpokeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_spoke" not in self._stubs: + self._stubs["create_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/CreateSpoke", + request_serializer=hub.CreateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_spoke"] + + @property + def update_spoke( + self, + ) -> Callable[[hub.UpdateSpokeRequest], operations_pb2.Operation]: + r"""Return a callable for the update spoke method over gRPC. + + Updates the parameters of the specified spoke. + + Returns: + Callable[[~.UpdateSpokeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_spoke" not in self._stubs: + self._stubs["update_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/UpdateSpoke", + request_serializer=hub.UpdateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_spoke"] + + @property + def deactivate_spoke( + self, + ) -> Callable[[hub.DeactivateSpokeRequest], operations_pb2.Operation]: + r"""Return a callable for the deactivate spoke method over gRPC. + + Deactivates the specified spoke. Deactivating keeps + the spoke information for future re-activation, but + disconnects the Google Cloud network from non-Google- + Cloud network. + + Returns: + Callable[[~.DeactivateSpokeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "deactivate_spoke" not in self._stubs: + self._stubs["deactivate_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeactivateSpoke", + request_serializer=hub.DeactivateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["deactivate_spoke"] + + @property + def activate_spoke( + self, + ) -> Callable[[hub.ActivateSpokeRequest], operations_pb2.Operation]: + r"""Return a callable for the activate spoke method over gRPC. + + Activates the specified spoke. Activating reconnects + the Google Cloud network with the non-Google-Cloud + network. + + Returns: + Callable[[~.ActivateSpokeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "activate_spoke" not in self._stubs: + self._stubs["activate_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ActivateSpoke", + request_serializer=hub.ActivateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["activate_spoke"] + + @property + def delete_spoke( + self, + ) -> Callable[[hub.DeleteSpokeRequest], operations_pb2.Operation]: + r"""Return a callable for the delete spoke method over gRPC. + + Deletes the specified spoke. + + Returns: + Callable[[~.DeleteSpokeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_spoke" not in self._stubs: + self._stubs["delete_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeleteSpoke", + request_serializer=hub.DeleteSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_spoke"] + + +__all__ = ("HubServiceGrpcTransport",) diff --git a/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc_asyncio.py b/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..fbb6d90 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/services/hub_service/transports/grpc_asyncio.py @@ -0,0 +1,571 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.longrunning import operations_pb2 # type: ignore +from .base import HubServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import HubServiceGrpcTransport + + +class HubServiceGrpcAsyncIOTransport(HubServiceTransport): + """gRPC AsyncIO backend transport for HubService. + + Network Connectivity Center is a hub-and-spoke abstraction + for network connectivity management in Google Cloud. It reduces + operational complexity through a simple, centralized + connectivity management model. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "networkconnectivity.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this 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 optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "networkconnectivity.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + 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. + This argument is ignored if ``channel`` is provided. + 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 optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Sanity check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def list_hubs( + self, + ) -> Callable[[hub.ListHubsRequest], Awaitable[hub.ListHubsResponse]]: + r"""Return a callable for the list hubs method over gRPC. + + Lists hubs in a given project. + + Returns: + Callable[[~.ListHubsRequest], + Awaitable[~.ListHubsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_hubs" not in self._stubs: + self._stubs["list_hubs"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ListHubs", + request_serializer=hub.ListHubsRequest.serialize, + response_deserializer=hub.ListHubsResponse.deserialize, + ) + return self._stubs["list_hubs"] + + @property + def get_hub(self) -> Callable[[hub.GetHubRequest], Awaitable[hub.Hub]]: + r"""Return a callable for the get hub method over gRPC. + + Gets details about the specified hub. + + Returns: + Callable[[~.GetHubRequest], + Awaitable[~.Hub]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_hub" not in self._stubs: + self._stubs["get_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/GetHub", + request_serializer=hub.GetHubRequest.serialize, + response_deserializer=hub.Hub.deserialize, + ) + return self._stubs["get_hub"] + + @property + def create_hub( + self, + ) -> Callable[[gcn_hub.CreateHubRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create hub method over gRPC. + + Creates a new hub in the specified project. + + Returns: + Callable[[~.CreateHubRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_hub" not in self._stubs: + self._stubs["create_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/CreateHub", + request_serializer=gcn_hub.CreateHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_hub"] + + @property + def update_hub( + self, + ) -> Callable[[gcn_hub.UpdateHubRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update hub method over gRPC. + + Updates the description and/or labels of the + specified hub. + + Returns: + Callable[[~.UpdateHubRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_hub" not in self._stubs: + self._stubs["update_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/UpdateHub", + request_serializer=gcn_hub.UpdateHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_hub"] + + @property + def delete_hub( + self, + ) -> Callable[[hub.DeleteHubRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete hub method over gRPC. + + Deletes the specified hub. + + Returns: + Callable[[~.DeleteHubRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_hub" not in self._stubs: + self._stubs["delete_hub"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeleteHub", + request_serializer=hub.DeleteHubRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_hub"] + + @property + def list_spokes( + self, + ) -> Callable[[hub.ListSpokesRequest], Awaitable[hub.ListSpokesResponse]]: + r"""Return a callable for the list spokes method over gRPC. + + Lists the spokes in the specified project and + location. + + Returns: + Callable[[~.ListSpokesRequest], + Awaitable[~.ListSpokesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_spokes" not in self._stubs: + self._stubs["list_spokes"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ListSpokes", + request_serializer=hub.ListSpokesRequest.serialize, + response_deserializer=hub.ListSpokesResponse.deserialize, + ) + return self._stubs["list_spokes"] + + @property + def get_spoke(self) -> Callable[[hub.GetSpokeRequest], Awaitable[hub.Spoke]]: + r"""Return a callable for the get spoke method over gRPC. + + Gets details about the specified spoke. + + Returns: + Callable[[~.GetSpokeRequest], + Awaitable[~.Spoke]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_spoke" not in self._stubs: + self._stubs["get_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/GetSpoke", + request_serializer=hub.GetSpokeRequest.serialize, + response_deserializer=hub.Spoke.deserialize, + ) + return self._stubs["get_spoke"] + + @property + def create_spoke( + self, + ) -> Callable[[hub.CreateSpokeRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the create spoke method over gRPC. + + Creates a spoke in the specified project and + location. + + Returns: + Callable[[~.CreateSpokeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_spoke" not in self._stubs: + self._stubs["create_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/CreateSpoke", + request_serializer=hub.CreateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_spoke"] + + @property + def update_spoke( + self, + ) -> Callable[[hub.UpdateSpokeRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the update spoke method over gRPC. + + Updates the parameters of the specified spoke. + + Returns: + Callable[[~.UpdateSpokeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_spoke" not in self._stubs: + self._stubs["update_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/UpdateSpoke", + request_serializer=hub.UpdateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_spoke"] + + @property + def deactivate_spoke( + self, + ) -> Callable[[hub.DeactivateSpokeRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the deactivate spoke method over gRPC. + + Deactivates the specified spoke. Deactivating keeps + the spoke information for future re-activation, but + disconnects the Google Cloud network from non-Google- + Cloud network. + + Returns: + Callable[[~.DeactivateSpokeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "deactivate_spoke" not in self._stubs: + self._stubs["deactivate_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeactivateSpoke", + request_serializer=hub.DeactivateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["deactivate_spoke"] + + @property + def activate_spoke( + self, + ) -> Callable[[hub.ActivateSpokeRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the activate spoke method over gRPC. + + Activates the specified spoke. Activating reconnects + the Google Cloud network with the non-Google-Cloud + network. + + Returns: + Callable[[~.ActivateSpokeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "activate_spoke" not in self._stubs: + self._stubs["activate_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/ActivateSpoke", + request_serializer=hub.ActivateSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["activate_spoke"] + + @property + def delete_spoke( + self, + ) -> Callable[[hub.DeleteSpokeRequest], Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the delete spoke method over gRPC. + + Deletes the specified spoke. + + Returns: + Callable[[~.DeleteSpokeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_spoke" not in self._stubs: + self._stubs["delete_spoke"] = self.grpc_channel.unary_unary( + "/google.cloud.networkconnectivity.v1.HubService/DeleteSpoke", + request_serializer=hub.DeleteSpokeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_spoke"] + + +__all__ = ("HubServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/networkconnectivity_v1/types/__init__.py b/google/cloud/networkconnectivity_v1/types/__init__.py new file mode 100644 index 0000000..8d56928 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/types/__init__.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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 .common import OperationMetadata +from .hub import ( + ActivateSpokeRequest, + CreateHubRequest, + CreateSpokeRequest, + DeactivateSpokeRequest, + DeleteHubRequest, + DeleteSpokeRequest, + GetHubRequest, + GetSpokeRequest, + Hub, + LinkedInterconnectAttachments, + LinkedRouterApplianceInstances, + LinkedVpnTunnels, + ListHubsRequest, + ListHubsResponse, + ListSpokesRequest, + ListSpokesResponse, + RouterApplianceInstance, + Spoke, + UpdateHubRequest, + UpdateSpokeRequest, + State, +) + +__all__ = ( + "OperationMetadata", + "ActivateSpokeRequest", + "CreateHubRequest", + "CreateSpokeRequest", + "DeactivateSpokeRequest", + "DeleteHubRequest", + "DeleteSpokeRequest", + "GetHubRequest", + "GetSpokeRequest", + "Hub", + "LinkedInterconnectAttachments", + "LinkedRouterApplianceInstances", + "LinkedVpnTunnels", + "ListHubsRequest", + "ListHubsResponse", + "ListSpokesRequest", + "ListSpokesResponse", + "RouterApplianceInstance", + "Spoke", + "UpdateHubRequest", + "UpdateSpokeRequest", + "State", +) diff --git a/google/cloud/networkconnectivity_v1/types/common.py b/google/cloud/networkconnectivity_v1/types/common.py new file mode 100644 index 0000000..d839533 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/types/common.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import proto # type: ignore + +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.networkconnectivity.v1", manifest={"OperationMetadata",}, +) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of the long-running operation. + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the operation was + created. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the operation finished + running. + target (str): + Output only. Server-defined resource path for + the target of the operation. + verb (str): + Output only. Name of the verb executed by the + operation. + status_message (str): + Output only. Human-readable status of the + operation, if any. + requested_cancellation (bool): + Output only. Identifies whether the user has requested + cancellation of the operation. Operations that have + successfully been cancelled have [Operation.error][] value + with a [google.rpc.Status.code][google.rpc.Status.code] of + 1, corresponding to ``Code.CANCELLED``. + api_version (str): + Output only. API version used to start the + operation. + """ + + create_time = proto.Field(proto.MESSAGE, number=1, message=timestamp_pb2.Timestamp,) + end_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,) + target = proto.Field(proto.STRING, number=3,) + verb = proto.Field(proto.STRING, number=4,) + status_message = proto.Field(proto.STRING, number=5,) + requested_cancellation = proto.Field(proto.BOOL, number=6,) + api_version = proto.Field(proto.STRING, number=7,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/networkconnectivity_v1/types/hub.py b/google/cloud/networkconnectivity_v1/types/hub.py new file mode 100644 index 0000000..66334e9 --- /dev/null +++ b/google/cloud/networkconnectivity_v1/types/hub.py @@ -0,0 +1,698 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import proto # type: ignore + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.networkconnectivity.v1", + manifest={ + "State", + "Hub", + "Spoke", + "ListHubsRequest", + "ListHubsResponse", + "GetHubRequest", + "CreateHubRequest", + "UpdateHubRequest", + "DeleteHubRequest", + "ListSpokesRequest", + "ListSpokesResponse", + "GetSpokeRequest", + "CreateSpokeRequest", + "UpdateSpokeRequest", + "DeleteSpokeRequest", + "DeactivateSpokeRequest", + "ActivateSpokeRequest", + "LinkedVpnTunnels", + "LinkedInterconnectAttachments", + "LinkedRouterApplianceInstances", + "RouterApplianceInstance", + }, +) + + +class State(proto.Enum): + r"""The State enum represents the lifecycle stage of a Network + Connectivity Center resource. + """ + STATE_UNSPECIFIED = 0 + CREATING = 1 + ACTIVE = 2 + DELETING = 3 + + +class Hub(proto.Message): + r"""A hub is essentially a collection of spokes. A single hub can + contain spokes from multiple regions. However, all of a hub's + spokes must be associated with resources that reside in the same + VPC network. + + Attributes: + name (str): + Immutable. The name of the hub. Hub names must be unique. + They use the following form: + ``projects/{project_number}/locations/global/hubs/{hub_id}`` + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the hub was created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the hub was last + updated. + labels (Sequence[google.cloud.networkconnectivity_v1.types.Hub.LabelsEntry]): + Optional labels in key:value format. For more information + about labels, see `Requirements for + labels `__. + description (str): + An optional description of the hub. + unique_id (str): + Output only. The Google-generated UUID for the hub. This + value is unique across all hub resources. If a hub is + deleted and another with the same name is created, the new + hub is assigned a different unique_id. + state (google.cloud.networkconnectivity_v1.types.State): + Output only. The current lifecycle state of + this hub. + """ + + name = proto.Field(proto.STRING, number=1,) + create_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,) + update_time = proto.Field(proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp,) + labels = proto.MapField(proto.STRING, proto.STRING, number=4,) + description = proto.Field(proto.STRING, number=5,) + unique_id = proto.Field(proto.STRING, number=8,) + state = proto.Field(proto.ENUM, number=9, enum="State",) + + +class Spoke(proto.Message): + r"""A spoke represents a connection between your Google Cloud network + resources and a non-Google-Cloud network. + + When you create a spoke, you associate it with a hub. You must also + identify a value for exactly one of the following fields: + + - linked_vpn_tunnels + - linked_interconnect_attachments + - linked_router_appliance_instances + + Attributes: + name (str): + Immutable. The name of the spoke. Spoke names must be + unique. They use the following form: + ``projects/{project_number}/locations/{region}/spokes/{spoke_id}`` + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the spoke was created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time the spoke was last + updated. + labels (Sequence[google.cloud.networkconnectivity_v1.types.Spoke.LabelsEntry]): + Optional labels in key:value format. For more information + about labels, see `Requirements for + labels `__. + description (str): + An optional description of the spoke. + hub (str): + Immutable. The URI of the hub that this spoke + is attached to. + linked_vpn_tunnels (google.cloud.networkconnectivity_v1.types.LinkedVpnTunnels): + VPN tunnels that are associated with the + spoke. + linked_interconnect_attachments (google.cloud.networkconnectivity_v1.types.LinkedInterconnectAttachments): + VLAN attachments that are associated with the + spoke. + linked_router_appliance_instances (google.cloud.networkconnectivity_v1.types.LinkedRouterApplianceInstances): + Router appliance instances that are + associated with the spoke. + unique_id (str): + Output only. The Google-generated UUID for the spoke. This + value is unique across all spoke resources. If a spoke is + deleted and another with the same name is created, the new + spoke is assigned a different unique_id. + state (google.cloud.networkconnectivity_v1.types.State): + Output only. The current lifecycle state of + this spoke. + """ + + name = proto.Field(proto.STRING, number=1,) + create_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,) + update_time = proto.Field(proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp,) + labels = proto.MapField(proto.STRING, proto.STRING, number=4,) + description = proto.Field(proto.STRING, number=5,) + hub = proto.Field(proto.STRING, number=6,) + linked_vpn_tunnels = proto.Field( + proto.MESSAGE, number=17, message="LinkedVpnTunnels", + ) + linked_interconnect_attachments = proto.Field( + proto.MESSAGE, number=18, message="LinkedInterconnectAttachments", + ) + linked_router_appliance_instances = proto.Field( + proto.MESSAGE, number=19, message="LinkedRouterApplianceInstances", + ) + unique_id = proto.Field(proto.STRING, number=11,) + state = proto.Field(proto.ENUM, number=15, enum="State",) + + +class ListHubsRequest(proto.Message): + r"""Request for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + + Attributes: + parent (str): + Required. The parent resource's name. + page_size (int): + The maximum number of results per page that + should be returned. + page_token (str): + The page token. + filter (str): + An expression that filters the results listed + in the response. + order_by (str): + Sort the results by a certain order. + """ + + parent = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + filter = proto.Field(proto.STRING, number=4,) + order_by = proto.Field(proto.STRING, number=5,) + + +class ListHubsResponse(proto.Message): + r"""Response for + [HubService.ListHubs][google.cloud.networkconnectivity.v1.HubService.ListHubs] + method. + + Attributes: + hubs (Sequence[google.cloud.networkconnectivity_v1.types.Hub]): + The requested hubs. + next_page_token (str): + The next pagination token in the List response. It should be + used as page_token for the following request. An empty value + means no more result. + unreachable (Sequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + hubs = proto.RepeatedField(proto.MESSAGE, number=1, message="Hub",) + next_page_token = proto.Field(proto.STRING, number=2,) + unreachable = proto.RepeatedField(proto.STRING, number=3,) + + +class GetHubRequest(proto.Message): + r"""Request for + [HubService.GetHub][google.cloud.networkconnectivity.v1.HubService.GetHub] + method. + + Attributes: + name (str): + Required. The name of the hub resource to + get. + """ + + name = proto.Field(proto.STRING, number=1,) + + +class CreateHubRequest(proto.Message): + r"""Request for + [HubService.CreateHub][google.cloud.networkconnectivity.v1.HubService.CreateHub] + method. + + Attributes: + parent (str): + Required. The parent resource. + hub_id (str): + Optional. A unique identifier for the hub. + hub (google.cloud.networkconnectivity_v1.types.Hub): + Required. The initial values for a new hub. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + parent = proto.Field(proto.STRING, number=1,) + hub_id = proto.Field(proto.STRING, number=2,) + hub = proto.Field(proto.MESSAGE, number=3, message="Hub",) + request_id = proto.Field(proto.STRING, number=4,) + + +class UpdateHubRequest(proto.Message): + r"""Request for + [HubService.UpdateHub][google.cloud.networkconnectivity.v1.HubService.UpdateHub] + method. + + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. In the case of an update to an existing hub, field + mask is used to specify the fields to be overwritten. The + fields specified in the update_mask are relative to the + resource, not the full request. A field is overwritten if it + is in the mask. If the user does not provide a mask, then + all fields are overwritten. + hub (google.cloud.networkconnectivity_v1.types.Hub): + Required. The state that the hub should be in + after the update. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + update_mask = proto.Field( + proto.MESSAGE, number=1, message=field_mask_pb2.FieldMask, + ) + hub = proto.Field(proto.MESSAGE, number=2, message="Hub",) + request_id = proto.Field(proto.STRING, number=3,) + + +class DeleteHubRequest(proto.Message): + r"""The request for + [HubService.DeleteHub][google.cloud.networkconnectivity.v1.HubService.DeleteHub]. + + Attributes: + name (str): + Required. The name of the hub to delete. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + name = proto.Field(proto.STRING, number=1,) + request_id = proto.Field(proto.STRING, number=2,) + + +class ListSpokesRequest(proto.Message): + r"""The request for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + + Attributes: + parent (str): + Required. The parent resource. + page_size (int): + The maximum number of results per page that + should be returned. + page_token (str): + The page token. + filter (str): + An expression that filters the results listed + in the response. + order_by (str): + Sort the results by a certain order. + """ + + parent = proto.Field(proto.STRING, number=1,) + page_size = proto.Field(proto.INT32, number=2,) + page_token = proto.Field(proto.STRING, number=3,) + filter = proto.Field(proto.STRING, number=4,) + order_by = proto.Field(proto.STRING, number=5,) + + +class ListSpokesResponse(proto.Message): + r"""The response for + [HubService.ListSpokes][google.cloud.networkconnectivity.v1.HubService.ListSpokes]. + + Attributes: + spokes (Sequence[google.cloud.networkconnectivity_v1.types.Spoke]): + The requested spokes. + next_page_token (str): + The next pagination token in the List response. It should be + used as page_token for the following request. An empty value + means no more result. + unreachable (Sequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + spokes = proto.RepeatedField(proto.MESSAGE, number=1, message="Spoke",) + next_page_token = proto.Field(proto.STRING, number=2,) + unreachable = proto.RepeatedField(proto.STRING, number=3,) + + +class GetSpokeRequest(proto.Message): + r"""The request for + [HubService.GetSpoke][google.cloud.networkconnectivity.v1.HubService.GetSpoke]. + + Attributes: + name (str): + Required. The name of the spoke resource. + """ + + name = proto.Field(proto.STRING, number=1,) + + +class CreateSpokeRequest(proto.Message): + r"""The request for + [HubService.CreateSpoke][google.cloud.networkconnectivity.v1.HubService.CreateSpoke]. + + Attributes: + parent (str): + Required. The parent resource. + spoke_id (str): + Optional. Unique id for the spoke to create. + spoke (google.cloud.networkconnectivity_v1.types.Spoke): + Required. The initial values for a new spoke. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + parent = proto.Field(proto.STRING, number=1,) + spoke_id = proto.Field(proto.STRING, number=2,) + spoke = proto.Field(proto.MESSAGE, number=3, message="Spoke",) + request_id = proto.Field(proto.STRING, number=4,) + + +class UpdateSpokeRequest(proto.Message): + r"""Request for + [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1.HubService.UpdateSpoke] + method. + + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. In the case of an update to an existing spoke, + field mask is used to specify the fields to be overwritten. + The fields specified in the update_mask are relative to the + resource, not the full request. A field is overwritten if it + is in the mask. If the user does not provide a mask, then + all fields are overwritten. + spoke (google.cloud.networkconnectivity_v1.types.Spoke): + Required. The state that the spoke should be + in after the update. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + update_mask = proto.Field( + proto.MESSAGE, number=1, message=field_mask_pb2.FieldMask, + ) + spoke = proto.Field(proto.MESSAGE, number=2, message="Spoke",) + request_id = proto.Field(proto.STRING, number=3,) + + +class DeleteSpokeRequest(proto.Message): + r"""The request for + [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1.HubService.DeleteSpoke]. + + Attributes: + name (str): + Required. The name of the spoke to delete. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + name = proto.Field(proto.STRING, number=1,) + request_id = proto.Field(proto.STRING, number=2,) + + +class DeactivateSpokeRequest(proto.Message): + r"""The request for + [HubService.DeactivateSpoke][google.cloud.networkconnectivity.v1.HubService.DeactivateSpoke]. + + Attributes: + name (str): + Required. The name of the spoke to + deactivate. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + name = proto.Field(proto.STRING, number=1,) + request_id = proto.Field(proto.STRING, number=2,) + + +class ActivateSpokeRequest(proto.Message): + r"""The request for + [HubService.ActivateSpoke][google.cloud.networkconnectivity.v1.HubService.ActivateSpoke]. + + Attributes: + name (str): + Required. The name of the spoke to activate. + request_id (str): + Optional. A unique request ID (optional). If + you specify this ID, you can use it in cases + when you need to retry your request. When you + need to retry, this ID lets the server know that + it can ignore the request if it has already been + completed. The server guarantees that for at + least 60 minutes after the first request. + + For example, consider a situation where you make + an initial request and the request times out. If + you make the request again with the same request + ID, the server can check to see whether the + original operation was received. If it was, the + server ignores the second request. This behavior + prevents clients from mistakenly creating + duplicate commitments. + The request ID must be a valid UUID, with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + """ + + name = proto.Field(proto.STRING, number=1,) + request_id = proto.Field(proto.STRING, number=2,) + + +class LinkedVpnTunnels(proto.Message): + r"""A collection of Cloud VPN tunnel resources. These resources + should be redundant HA VPN tunnels that all advertise the same + prefixes to Google Cloud. Alternatively, in a passive/active + configuration, all tunnels should be capable of advertising the + same prefixes. + + Attributes: + uris (Sequence[str]): + The URIs of linked VPN tunnel resources. + site_to_site_data_transfer (bool): + A value that controls whether site-to-site + data transfer is enabled for these resources. If + true, routes are propagated between the spoke + associated with these resources and other spokes + in the hub that have data transfer enabled. If + false, the spoke associated with these resources + provides connectivity only between the external + site and Google Cloud. In regions where data + transfer is unsupported, you cannot set this + field to true. + """ + + uris = proto.RepeatedField(proto.STRING, number=1,) + site_to_site_data_transfer = proto.Field(proto.BOOL, number=2,) + + +class LinkedInterconnectAttachments(proto.Message): + r"""A collection of VLAN attachment resources. These resources + should be redundant attachments that all advertise the same + prefixes to Google Cloud. Alternatively, in active/passive + configurations, all attachments should be capable of advertising + the same prefixes. + + Attributes: + uris (Sequence[str]): + The URIs of linked interconnect attachment + resources + site_to_site_data_transfer (bool): + A value that controls whether site-to-site + data transfer is enabled for these resources. If + true, routes are propagated between the spoke + associated with these resources and other spokes + in the hub that have data transfer enabled. If + false, the spoke associated with these resources + provides connectivity only between the external + site and Google Cloud. In regions where data + transfer is unsupported, you cannot set this + field to true. + """ + + uris = proto.RepeatedField(proto.STRING, number=1,) + site_to_site_data_transfer = proto.Field(proto.BOOL, number=2,) + + +class LinkedRouterApplianceInstances(proto.Message): + r"""A collection of router appliance instances. If you have + multiple router appliance instances connected to the same site, + they should all be attached to the same spoke. + + Attributes: + instances (Sequence[google.cloud.networkconnectivity_v1.types.RouterApplianceInstance]): + The list of router appliance instances. + site_to_site_data_transfer (bool): + A value that controls whether site-to-site + data transfer is enabled for these resources. If + true, routes are propagated between the spoke + associated with these resources and other spokes + in the hub that have data transfer enabled. If + false, the spoke associated with these resources + provides connectivity only between the external + site and Google Cloud. In regions where data + transfer is unsupported, you cannot set this + field to true. + """ + + instances = proto.RepeatedField( + proto.MESSAGE, number=1, message="RouterApplianceInstance", + ) + site_to_site_data_transfer = proto.Field(proto.BOOL, number=2,) + + +class RouterApplianceInstance(proto.Message): + r"""A router appliance instance is a Compute Engine virtual + machine (VM) instance that acts as a BGP speaker. A router + appliance instance is specified by the URI of the VM and the + internal IP address of one of the VM's network interfaces. + + Attributes: + virtual_machine (str): + The URI of the VM. + ip_address (str): + The IP address on the VM to use for peering. + """ + + virtual_machine = proto.Field(proto.STRING, number=1,) + ip_address = proto.Field(proto.STRING, number=3,) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owlbot.py b/owlbot.py index 5f258e4..d420f69 100644 --- a/owlbot.py +++ b/owlbot.py @@ -22,7 +22,7 @@ common = gcp.CommonTemplates() -default_version = "v1alpha1" +default_version = "v1" for library in s.get_staging_dirs(default_version): s.move(library, excludes=["setup.py", "README.rst", "docs/index.rst"]) diff --git a/scripts/fixup_networkconnectivity_v1_keywords.py b/scripts/fixup_networkconnectivity_v1_keywords.py new file mode 100644 index 0000000..786f368 --- /dev/null +++ b/scripts/fixup_networkconnectivity_v1_keywords.py @@ -0,0 +1,187 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class networkconnectivityCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'activate_spoke': ('name', 'request_id', ), + 'create_hub': ('parent', 'hub', 'hub_id', 'request_id', ), + 'create_spoke': ('parent', 'spoke', 'spoke_id', 'request_id', ), + 'deactivate_spoke': ('name', 'request_id', ), + 'delete_hub': ('name', 'request_id', ), + 'delete_spoke': ('name', 'request_id', ), + 'get_hub': ('name', ), + 'get_spoke': ('name', ), + 'list_hubs': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'list_spokes': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'update_hub': ('hub', 'update_mask', 'request_id', ), + 'update_spoke': ('spoke', 'update_mask', 'request_id', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: not a.keyword.value in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=networkconnectivityCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the networkconnectivity client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/setup.py b/setup.py index 1441749..2534c91 100644 --- a/setup.py +++ b/setup.py @@ -53,7 +53,7 @@ ), python_requires=">=3.6", classifiers=[ - "Development Status :: 3 - Alpha", + "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", diff --git a/tests/unit/gapic/networkconnectivity_v1/__init__.py b/tests/unit/gapic/networkconnectivity_v1/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/tests/unit/gapic/networkconnectivity_v1/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/tests/unit/gapic/networkconnectivity_v1/test_hub_service.py b/tests/unit/gapic/networkconnectivity_v1/test_hub_service.py new file mode 100644 index 0000000..9027e08 --- /dev/null +++ b/tests/unit/gapic/networkconnectivity_v1/test_hub_service.py @@ -0,0 +1,3814 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.networkconnectivity_v1.services.hub_service import ( + HubServiceAsyncClient, +) +from google.cloud.networkconnectivity_v1.services.hub_service import HubServiceClient +from google.cloud.networkconnectivity_v1.services.hub_service import pagers +from google.cloud.networkconnectivity_v1.services.hub_service import transports +from google.cloud.networkconnectivity_v1.services.hub_service.transports.base import ( + _GOOGLE_AUTH_VERSION, +) +from google.cloud.networkconnectivity_v1.types import common +from google.cloud.networkconnectivity_v1.types import hub +from google.cloud.networkconnectivity_v1.types import hub as gcn_hub +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert HubServiceClient._get_default_mtls_endpoint(None) is None + assert ( + HubServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + ) + assert ( + HubServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + HubServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + HubServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert HubServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [HubServiceClient, HubServiceAsyncClient,]) +def test_hub_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "networkconnectivity.googleapis.com:443" + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.HubServiceGrpcTransport, "grpc"), + (transports.HubServiceGrpcAsyncIOTransport, "grpc_asyncio"), + ], +) +def test_hub_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [HubServiceClient, HubServiceAsyncClient,]) +def test_hub_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "networkconnectivity.googleapis.com:443" + + +def test_hub_service_client_get_transport_class(): + transport = HubServiceClient.get_transport_class() + available_transports = [ + transports.HubServiceGrpcTransport, + ] + assert transport in available_transports + + transport = HubServiceClient.get_transport_class("grpc") + assert transport == transports.HubServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (HubServiceClient, transports.HubServiceGrpcTransport, "grpc"), + ( + HubServiceAsyncClient, + transports.HubServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +@mock.patch.object( + HubServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(HubServiceClient) +) +@mock.patch.object( + HubServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(HubServiceAsyncClient), +) +def test_hub_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(HubServiceClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(HubServiceClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError): + client = client_class() + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + (HubServiceClient, transports.HubServiceGrpcTransport, "grpc", "true"), + ( + HubServiceAsyncClient, + transports.HubServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + (HubServiceClient, transports.HubServiceGrpcTransport, "grpc", "false"), + ( + HubServiceAsyncClient, + transports.HubServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ], +) +@mock.patch.object( + HubServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(HubServiceClient) +) +@mock.patch.object( + HubServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(HubServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_hub_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (HubServiceClient, transports.HubServiceGrpcTransport, "grpc"), + ( + HubServiceAsyncClient, + transports.HubServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +def test_hub_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions(scopes=["1", "2"],) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (HubServiceClient, transports.HubServiceGrpcTransport, "grpc"), + ( + HubServiceAsyncClient, + transports.HubServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +def test_hub_service_client_client_options_credentials_file( + client_class, transport_class, transport_name +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_hub_service_client_client_options_from_dict(): + with mock.patch( + "google.cloud.networkconnectivity_v1.services.hub_service.transports.HubServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = HubServiceClient(client_options={"api_endpoint": "squid.clam.whelk"}) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_list_hubs(transport: str = "grpc", request_type=hub.ListHubsRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListHubsResponse( + next_page_token="next_page_token_value", unreachable=["unreachable_value"], + ) + response = client.list_hubs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListHubsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListHubsPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +def test_list_hubs_from_dict(): + test_list_hubs(request_type=dict) + + +def test_list_hubs_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + client.list_hubs() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListHubsRequest() + + +@pytest.mark.asyncio +async def test_list_hubs_async( + transport: str = "grpc_asyncio", request_type=hub.ListHubsRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListHubsResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + ) + response = await client.list_hubs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListHubsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListHubsAsyncPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +@pytest.mark.asyncio +async def test_list_hubs_async_from_dict(): + await test_list_hubs_async(request_type=dict) + + +def test_list_hubs_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ListHubsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + call.return_value = hub.ListHubsResponse() + client.list_hubs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_hubs_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ListHubsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListHubsResponse() + ) + await client.list_hubs(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_hubs_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListHubsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_hubs(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_hubs_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_hubs( + hub.ListHubsRequest(), parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_hubs_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListHubsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListHubsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_hubs(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_hubs_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_hubs( + hub.ListHubsRequest(), parent="parent_value", + ) + + +def test_list_hubs_pager(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListHubsResponse( + hubs=[hub.Hub(), hub.Hub(), hub.Hub(),], next_page_token="abc", + ), + hub.ListHubsResponse(hubs=[], next_page_token="def",), + hub.ListHubsResponse(hubs=[hub.Hub(),], next_page_token="ghi",), + hub.ListHubsResponse(hubs=[hub.Hub(), hub.Hub(),],), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_hubs(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, hub.Hub) for i in results) + + +def test_list_hubs_pages(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_hubs), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListHubsResponse( + hubs=[hub.Hub(), hub.Hub(), hub.Hub(),], next_page_token="abc", + ), + hub.ListHubsResponse(hubs=[], next_page_token="def",), + hub.ListHubsResponse(hubs=[hub.Hub(),], next_page_token="ghi",), + hub.ListHubsResponse(hubs=[hub.Hub(), hub.Hub(),],), + RuntimeError, + ) + pages = list(client.list_hubs(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_hubs_async_pager(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_hubs), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListHubsResponse( + hubs=[hub.Hub(), hub.Hub(), hub.Hub(),], next_page_token="abc", + ), + hub.ListHubsResponse(hubs=[], next_page_token="def",), + hub.ListHubsResponse(hubs=[hub.Hub(),], next_page_token="ghi",), + hub.ListHubsResponse(hubs=[hub.Hub(), hub.Hub(),],), + RuntimeError, + ) + async_pager = await client.list_hubs(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, hub.Hub) for i in responses) + + +@pytest.mark.asyncio +async def test_list_hubs_async_pages(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_hubs), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListHubsResponse( + hubs=[hub.Hub(), hub.Hub(), hub.Hub(),], next_page_token="abc", + ), + hub.ListHubsResponse(hubs=[], next_page_token="def",), + hub.ListHubsResponse(hubs=[hub.Hub(),], next_page_token="ghi",), + hub.ListHubsResponse(hubs=[hub.Hub(), hub.Hub(),],), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_hubs(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_hub(transport: str = "grpc", request_type=hub.GetHubRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Hub( + name="name_value", + description="description_value", + unique_id="unique_id_value", + state=hub.State.CREATING, + ) + response = client.get_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, hub.Hub) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.unique_id == "unique_id_value" + assert response.state == hub.State.CREATING + + +def test_get_hub_from_dict(): + test_get_hub(request_type=dict) + + +def test_get_hub_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + client.get_hub() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetHubRequest() + + +@pytest.mark.asyncio +async def test_get_hub_async( + transport: str = "grpc_asyncio", request_type=hub.GetHubRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.Hub( + name="name_value", + description="description_value", + unique_id="unique_id_value", + state=hub.State.CREATING, + ) + ) + response = await client.get_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, hub.Hub) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.unique_id == "unique_id_value" + assert response.state == hub.State.CREATING + + +@pytest.mark.asyncio +async def test_get_hub_async_from_dict(): + await test_get_hub_async(request_type=dict) + + +def test_get_hub_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.GetHubRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + call.return_value = hub.Hub() + client.get_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_hub_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.GetHubRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(hub.Hub()) + await client.get_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_hub_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Hub() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_hub(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_hub_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_hub( + hub.GetHubRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_hub_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Hub() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(hub.Hub()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_hub(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_hub_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_hub( + hub.GetHubRequest(), name="name_value", + ) + + +def test_create_hub(transport: str = "grpc", request_type=gcn_hub.CreateHubRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.CreateHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_hub_from_dict(): + test_create_hub(request_type=dict) + + +def test_create_hub_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + client.create_hub() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.CreateHubRequest() + + +@pytest.mark.asyncio +async def test_create_hub_async( + transport: str = "grpc_asyncio", request_type=gcn_hub.CreateHubRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.CreateHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_hub_async_from_dict(): + await test_create_hub_async(request_type=dict) + + +def test_create_hub_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcn_hub.CreateHubRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_hub_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcn_hub.CreateHubRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_create_hub_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_hub( + parent="parent_value", + hub=gcn_hub.Hub(name="name_value"), + hub_id="hub_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].hub == gcn_hub.Hub(name="name_value") + assert args[0].hub_id == "hub_id_value" + + +def test_create_hub_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_hub( + gcn_hub.CreateHubRequest(), + parent="parent_value", + hub=gcn_hub.Hub(name="name_value"), + hub_id="hub_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_hub_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_hub( + parent="parent_value", + hub=gcn_hub.Hub(name="name_value"), + hub_id="hub_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].hub == gcn_hub.Hub(name="name_value") + assert args[0].hub_id == "hub_id_value" + + +@pytest.mark.asyncio +async def test_create_hub_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_hub( + gcn_hub.CreateHubRequest(), + parent="parent_value", + hub=gcn_hub.Hub(name="name_value"), + hub_id="hub_id_value", + ) + + +def test_update_hub(transport: str = "grpc", request_type=gcn_hub.UpdateHubRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.UpdateHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_hub_from_dict(): + test_update_hub(request_type=dict) + + +def test_update_hub_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + client.update_hub() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.UpdateHubRequest() + + +@pytest.mark.asyncio +async def test_update_hub_async( + transport: str = "grpc_asyncio", request_type=gcn_hub.UpdateHubRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == gcn_hub.UpdateHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_hub_async_from_dict(): + await test_update_hub_async(request_type=dict) + + +def test_update_hub_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcn_hub.UpdateHubRequest() + + request.hub.name = "hub.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "hub.name=hub.name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_hub_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gcn_hub.UpdateHubRequest() + + request.hub.name = "hub.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "hub.name=hub.name/value",) in kw["metadata"] + + +def test_update_hub_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_hub( + hub=gcn_hub.Hub(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].hub == gcn_hub.Hub(name="name_value") + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +def test_update_hub_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_hub( + gcn_hub.UpdateHubRequest(), + hub=gcn_hub.Hub(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_hub_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_hub( + hub=gcn_hub.Hub(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].hub == gcn_hub.Hub(name="name_value") + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +@pytest.mark.asyncio +async def test_update_hub_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_hub( + gcn_hub.UpdateHubRequest(), + hub=gcn_hub.Hub(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_delete_hub(transport: str = "grpc", request_type=hub.DeleteHubRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_hub_from_dict(): + test_delete_hub(request_type=dict) + + +def test_delete_hub_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + client.delete_hub() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteHubRequest() + + +@pytest.mark.asyncio +async def test_delete_hub_async( + transport: str = "grpc_asyncio", request_type=hub.DeleteHubRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteHubRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_hub_async_from_dict(): + await test_delete_hub_async(request_type=dict) + + +def test_delete_hub_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeleteHubRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_hub_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeleteHubRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_hub(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_delete_hub_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_hub(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_delete_hub_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_hub( + hub.DeleteHubRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_hub_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_hub), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_hub(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_delete_hub_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_hub( + hub.DeleteHubRequest(), name="name_value", + ) + + +def test_list_spokes(transport: str = "grpc", request_type=hub.ListSpokesRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListSpokesResponse( + next_page_token="next_page_token_value", unreachable=["unreachable_value"], + ) + response = client.list_spokes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListSpokesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSpokesPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +def test_list_spokes_from_dict(): + test_list_spokes(request_type=dict) + + +def test_list_spokes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + client.list_spokes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListSpokesRequest() + + +@pytest.mark.asyncio +async def test_list_spokes_async( + transport: str = "grpc_asyncio", request_type=hub.ListSpokesRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListSpokesResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + ) + response = await client.list_spokes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ListSpokesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListSpokesAsyncPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +@pytest.mark.asyncio +async def test_list_spokes_async_from_dict(): + await test_list_spokes_async(request_type=dict) + + +def test_list_spokes_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ListSpokesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + call.return_value = hub.ListSpokesResponse() + client.list_spokes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_spokes_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ListSpokesRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListSpokesResponse() + ) + await client.list_spokes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_list_spokes_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListSpokesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_spokes(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +def test_list_spokes_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_spokes( + hub.ListSpokesRequest(), parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_spokes_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.ListSpokesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.ListSpokesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_spokes(parent="parent_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + + +@pytest.mark.asyncio +async def test_list_spokes_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_spokes( + hub.ListSpokesRequest(), parent="parent_value", + ) + + +def test_list_spokes_pager(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListSpokesResponse( + spokes=[hub.Spoke(), hub.Spoke(), hub.Spoke(),], next_page_token="abc", + ), + hub.ListSpokesResponse(spokes=[], next_page_token="def",), + hub.ListSpokesResponse(spokes=[hub.Spoke(),], next_page_token="ghi",), + hub.ListSpokesResponse(spokes=[hub.Spoke(), hub.Spoke(),],), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_spokes(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, hub.Spoke) for i in results) + + +def test_list_spokes_pages(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_spokes), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListSpokesResponse( + spokes=[hub.Spoke(), hub.Spoke(), hub.Spoke(),], next_page_token="abc", + ), + hub.ListSpokesResponse(spokes=[], next_page_token="def",), + hub.ListSpokesResponse(spokes=[hub.Spoke(),], next_page_token="ghi",), + hub.ListSpokesResponse(spokes=[hub.Spoke(), hub.Spoke(),],), + RuntimeError, + ) + pages = list(client.list_spokes(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_spokes_async_pager(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_spokes), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListSpokesResponse( + spokes=[hub.Spoke(), hub.Spoke(), hub.Spoke(),], next_page_token="abc", + ), + hub.ListSpokesResponse(spokes=[], next_page_token="def",), + hub.ListSpokesResponse(spokes=[hub.Spoke(),], next_page_token="ghi",), + hub.ListSpokesResponse(spokes=[hub.Spoke(), hub.Spoke(),],), + RuntimeError, + ) + async_pager = await client.list_spokes(request={},) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, hub.Spoke) for i in responses) + + +@pytest.mark.asyncio +async def test_list_spokes_async_pages(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials,) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_spokes), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + hub.ListSpokesResponse( + spokes=[hub.Spoke(), hub.Spoke(), hub.Spoke(),], next_page_token="abc", + ), + hub.ListSpokesResponse(spokes=[], next_page_token="def",), + hub.ListSpokesResponse(spokes=[hub.Spoke(),], next_page_token="ghi",), + hub.ListSpokesResponse(spokes=[hub.Spoke(), hub.Spoke(),],), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_spokes(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_spoke(transport: str = "grpc", request_type=hub.GetSpokeRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Spoke( + name="name_value", + description="description_value", + hub="hub_value", + unique_id="unique_id_value", + state=hub.State.CREATING, + ) + response = client.get_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, hub.Spoke) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.hub == "hub_value" + assert response.unique_id == "unique_id_value" + assert response.state == hub.State.CREATING + + +def test_get_spoke_from_dict(): + test_get_spoke(request_type=dict) + + +def test_get_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + client.get_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetSpokeRequest() + + +@pytest.mark.asyncio +async def test_get_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.GetSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + hub.Spoke( + name="name_value", + description="description_value", + hub="hub_value", + unique_id="unique_id_value", + state=hub.State.CREATING, + ) + ) + response = await client.get_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.GetSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, hub.Spoke) + assert response.name == "name_value" + assert response.description == "description_value" + assert response.hub == "hub_value" + assert response.unique_id == "unique_id_value" + assert response.state == hub.State.CREATING + + +@pytest.mark.asyncio +async def test_get_spoke_async_from_dict(): + await test_get_spoke_async(request_type=dict) + + +def test_get_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.GetSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + call.return_value = hub.Spoke() + client.get_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.GetSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(hub.Spoke()) + await client.get_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_get_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Spoke() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_get_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_spoke( + hub.GetSpokeRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = hub.Spoke() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(hub.Spoke()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_get_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_spoke( + hub.GetSpokeRequest(), name="name_value", + ) + + +def test_create_spoke(transport: str = "grpc", request_type=hub.CreateSpokeRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.CreateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_spoke_from_dict(): + test_create_spoke(request_type=dict) + + +def test_create_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + client.create_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.CreateSpokeRequest() + + +@pytest.mark.asyncio +async def test_create_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.CreateSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.CreateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_spoke_async_from_dict(): + await test_create_spoke_async(request_type=dict) + + +def test_create_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.CreateSpokeRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.CreateSpokeRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + + +def test_create_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_spoke( + parent="parent_value", + spoke=hub.Spoke(name="name_value"), + spoke_id="spoke_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].spoke == hub.Spoke(name="name_value") + assert args[0].spoke_id == "spoke_id_value" + + +def test_create_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_spoke( + hub.CreateSpokeRequest(), + parent="parent_value", + spoke=hub.Spoke(name="name_value"), + spoke_id="spoke_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.create_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_spoke( + parent="parent_value", + spoke=hub.Spoke(name="name_value"), + spoke_id="spoke_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == "parent_value" + assert args[0].spoke == hub.Spoke(name="name_value") + assert args[0].spoke_id == "spoke_id_value" + + +@pytest.mark.asyncio +async def test_create_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_spoke( + hub.CreateSpokeRequest(), + parent="parent_value", + spoke=hub.Spoke(name="name_value"), + spoke_id="spoke_id_value", + ) + + +def test_update_spoke(transport: str = "grpc", request_type=hub.UpdateSpokeRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.UpdateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_spoke_from_dict(): + test_update_spoke(request_type=dict) + + +def test_update_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + client.update_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.UpdateSpokeRequest() + + +@pytest.mark.asyncio +async def test_update_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.UpdateSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.UpdateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_spoke_async_from_dict(): + await test_update_spoke_async(request_type=dict) + + +def test_update_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.UpdateSpokeRequest() + + request.spoke.name = "spoke.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "spoke.name=spoke.name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.UpdateSpokeRequest() + + request.spoke.name = "spoke.name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "spoke.name=spoke.name/value",) in kw["metadata"] + + +def test_update_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_spoke( + spoke=hub.Spoke(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].spoke == hub.Spoke(name="name_value") + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +def test_update_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_spoke( + hub.UpdateSpokeRequest(), + spoke=hub.Spoke(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_spoke( + spoke=hub.Spoke(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].spoke == hub.Spoke(name="name_value") + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=["paths_value"]) + + +@pytest.mark.asyncio +async def test_update_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_spoke( + hub.UpdateSpokeRequest(), + spoke=hub.Spoke(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_deactivate_spoke( + transport: str = "grpc", request_type=hub.DeactivateSpokeRequest +): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.deactivate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeactivateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_deactivate_spoke_from_dict(): + test_deactivate_spoke(request_type=dict) + + +def test_deactivate_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + client.deactivate_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeactivateSpokeRequest() + + +@pytest.mark.asyncio +async def test_deactivate_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.DeactivateSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.deactivate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeactivateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_deactivate_spoke_async_from_dict(): + await test_deactivate_spoke_async(request_type=dict) + + +def test_deactivate_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeactivateSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.deactivate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_deactivate_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeactivateSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.deactivate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_deactivate_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.deactivate_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_deactivate_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.deactivate_spoke( + hub.DeactivateSpokeRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_deactivate_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.deactivate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.deactivate_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_deactivate_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.deactivate_spoke( + hub.DeactivateSpokeRequest(), name="name_value", + ) + + +def test_activate_spoke(transport: str = "grpc", request_type=hub.ActivateSpokeRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.activate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ActivateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_activate_spoke_from_dict(): + test_activate_spoke(request_type=dict) + + +def test_activate_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + client.activate_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ActivateSpokeRequest() + + +@pytest.mark.asyncio +async def test_activate_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.ActivateSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.activate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.ActivateSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_activate_spoke_async_from_dict(): + await test_activate_spoke_async(request_type=dict) + + +def test_activate_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ActivateSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.activate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_activate_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.ActivateSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.activate_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_activate_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.activate_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_activate_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.activate_spoke( + hub.ActivateSpokeRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_activate_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.activate_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.activate_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_activate_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.activate_spoke( + hub.ActivateSpokeRequest(), name="name_value", + ) + + +def test_delete_spoke(transport: str = "grpc", request_type=hub.DeleteSpokeRequest): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_spoke_from_dict(): + test_delete_spoke(request_type=dict) + + +def test_delete_spoke_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + client.delete_spoke() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteSpokeRequest() + + +@pytest.mark.asyncio +async def test_delete_spoke_async( + transport: str = "grpc_asyncio", request_type=hub.DeleteSpokeRequest +): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == hub.DeleteSpokeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_spoke_async_from_dict(): + await test_delete_spoke_async(request_type=dict) + + +def test_delete_spoke_field_headers(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeleteSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_spoke_field_headers_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = hub.DeleteSpokeRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_spoke(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + + +def test_delete_spoke_flattened(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +def test_delete_spoke_flattened_error(): + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_spoke( + hub.DeleteSpokeRequest(), name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_spoke_flattened_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_spoke), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_spoke(name="name_value",) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].name == "name_value" + + +@pytest.mark.asyncio +async def test_delete_spoke_flattened_error_async(): + client = HubServiceAsyncClient(credentials=ga_credentials.AnonymousCredentials(),) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_spoke( + hub.DeleteSpokeRequest(), name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.HubServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.HubServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = HubServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.HubServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = HubServiceClient( + client_options={"scopes": ["1", "2"]}, transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.HubServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = HubServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.HubServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.HubServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport,], +) +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_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = HubServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + assert isinstance(client.transport, transports.HubServiceGrpcTransport,) + + +def test_hub_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.HubServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_hub_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.networkconnectivity_v1.services.hub_service.transports.HubServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.HubServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "list_hubs", + "get_hub", + "create_hub", + "update_hub", + "delete_hub", + "list_spokes", + "get_spoke", + "create_spoke", + "update_spoke", + "deactivate_spoke", + "activate_spoke", + "delete_spoke", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + +@requires_google_auth_gte_1_25_0 +def test_hub_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.networkconnectivity_v1.services.hub_service.transports.HubServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.HubServiceTransport( + 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", + ) + + +@requires_google_auth_lt_1_25_0 +def test_hub_service_base_transport_with_credentials_file_old_google_auth(): + # 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.networkconnectivity_v1.services.hub_service.transports.HubServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.HubServiceTransport( + credentials_file="credentials.json", quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_hub_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.networkconnectivity_v1.services.hub_service.transports.HubServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.HubServiceTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_hub_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + HubServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_hub_service_auth_adc_old_google_auth(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + HubServiceClient() + adc.assert_called_once_with( + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport,], +) +@requires_google_auth_gte_1_25_0 +def test_hub_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport,], +) +@requires_google_auth_lt_1_25_0 +def test_hub_service_transport_auth_adc_old_google_auth(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus") + adc.assert_called_once_with( + scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.HubServiceGrpcTransport, grpc_helpers), + (transports.HubServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_hub_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "networkconnectivity.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="networkconnectivity.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport], +) +def test_hub_service_grpc_transport_client_cert_source_for_mtls(transport_class): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_hub_service_host_no_port(): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="networkconnectivity.googleapis.com" + ), + ) + assert client.transport._host == "networkconnectivity.googleapis.com:443" + + +def test_hub_service_host_with_port(): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="networkconnectivity.googleapis.com:8000" + ), + ) + assert client.transport._host == "networkconnectivity.googleapis.com:8000" + + +def test_hub_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.HubServiceGrpcTransport( + host="squid.clam.whelk", channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_hub_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.HubServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport], +) +def test_hub_service_transport_channel_mtls_with_client_cert_source(transport_class): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.HubServiceGrpcTransport, transports.HubServiceGrpcAsyncIOTransport], +) +def test_hub_service_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_hub_service_grpc_lro_client(): + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance(transport.operations_client, operations_v1.OperationsClient,) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_hub_service_grpc_lro_async_client(): + client = HubServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance(transport.operations_client, operations_v1.OperationsAsyncClient,) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_hub_path(): + project = "squid" + hub = "clam" + expected = "projects/{project}/locations/global/hubs/{hub}".format( + project=project, hub=hub, + ) + actual = HubServiceClient.hub_path(project, hub) + assert expected == actual + + +def test_parse_hub_path(): + expected = { + "project": "whelk", + "hub": "octopus", + } + path = HubServiceClient.hub_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_hub_path(path) + assert expected == actual + + +def test_instance_path(): + project = "oyster" + zone = "nudibranch" + instance = "cuttlefish" + expected = "projects/{project}/zones/{zone}/instances/{instance}".format( + project=project, zone=zone, instance=instance, + ) + actual = HubServiceClient.instance_path(project, zone, instance) + assert expected == actual + + +def test_parse_instance_path(): + expected = { + "project": "mussel", + "zone": "winkle", + "instance": "nautilus", + } + path = HubServiceClient.instance_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_instance_path(path) + assert expected == actual + + +def test_interconnect_attachment_path(): + project = "scallop" + region = "abalone" + resource_id = "squid" + expected = "projects/{project}/regions/{region}/interconnectAttachments/{resource_id}".format( + project=project, region=region, resource_id=resource_id, + ) + actual = HubServiceClient.interconnect_attachment_path(project, region, resource_id) + assert expected == actual + + +def test_parse_interconnect_attachment_path(): + expected = { + "project": "clam", + "region": "whelk", + "resource_id": "octopus", + } + path = HubServiceClient.interconnect_attachment_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_interconnect_attachment_path(path) + assert expected == actual + + +def test_spoke_path(): + project = "oyster" + location = "nudibranch" + spoke = "cuttlefish" + expected = "projects/{project}/locations/{location}/spokes/{spoke}".format( + project=project, location=location, spoke=spoke, + ) + actual = HubServiceClient.spoke_path(project, location, spoke) + assert expected == actual + + +def test_parse_spoke_path(): + expected = { + "project": "mussel", + "location": "winkle", + "spoke": "nautilus", + } + path = HubServiceClient.spoke_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_spoke_path(path) + assert expected == actual + + +def test_vpn_tunnel_path(): + project = "scallop" + region = "abalone" + resource_id = "squid" + expected = "projects/{project}/regions/{region}/vpnTunnels/{resource_id}".format( + project=project, region=region, resource_id=resource_id, + ) + actual = HubServiceClient.vpn_tunnel_path(project, region, resource_id) + assert expected == actual + + +def test_parse_vpn_tunnel_path(): + expected = { + "project": "clam", + "region": "whelk", + "resource_id": "octopus", + } + path = HubServiceClient.vpn_tunnel_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_vpn_tunnel_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = HubServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = HubServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format(folder=folder,) + actual = HubServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = HubServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format(organization=organization,) + actual = HubServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = HubServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format(project=project,) + actual = HubServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = HubServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format( + project=project, location=location, + ) + actual = HubServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = HubServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = HubServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.HubServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = HubServiceClient( + credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.HubServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = HubServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + ) + prep.assert_called_once_with(client_info)