2.16.0 (latest) 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.1 2.7.1 2.6.0 2.5.1 2.4.5 2.3.0 2.2.0 2.0.2 1.6.1 1.5.0 1.4.4 1.3.2 1.2.2 1.1.0 1.0.1 0.6.3 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 HubServiceClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.networkconnectivity_v1beta.services.hub_service.transports.base.HubServiceTransport, typing.Callable[ [...], google.cloud.networkconnectivity_v1beta.services.hub_service.transports.base.HubServiceTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) 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. ## Properties ### api_endpoint Return the API endpoint used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The API endpoint used by the client instance. | ### transport Returns the transport used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `HubServiceTransport` | The transport used by the client instance. | ### universe_domain Return the universe domain used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The universe domain used by the client instance. | ## Methods ### HubServiceClient HubServiceClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.networkconnectivity_v1beta.services.hub_service.transports.base.HubServiceTransport, typing.Callable[ [...], google.cloud.networkconnectivity_v1beta.services.hub_service.transports.base.HubServiceTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Instantiates the hub service client. | **Parameters** || |---|---| | **Name** | **Description** | | `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` | `Optional[Union[str,HubServiceTransport,Callable[..., HubServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the HubServiceTransport constructor. If set to None, a transport is chosen automatically. | | `client_options` | `Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS. | | `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. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If mutual TLS transport creation failed for any reason. | ### __exit__ __exit__(type, value, traceback) Releases underlying transport's resources. > [!WARNING] > **Warning:** ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients! ### accept_hub_spoke accept_hub_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.AcceptHubSpokeRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, spoke_uri: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Accepts a proposal to attach a Network Connectivity Center spoke to a hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_accept_hub_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptHubSpokeRequest.html( name="name_value", spoke_uri="spoke_uri_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_accept_hub_spoke(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptHubSpokeRequest, dict]` The request object. The request for HubService.AcceptHubSpoke. | | `name` | `str` Required. The name of the hub into which to accept the spoke. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_uri` | `str` Required. The URI of the spoke to accept into the hub. This corresponds to the `spoke_uri` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [AcceptHubSpokeResponse](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptHubSpokeResponse) The response for HubService.AcceptHubSpoke. | ### accept_spoke_update accept_spoke_update( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.AcceptSpokeUpdateRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, spoke_uri: typing.Optional[str] = None, spoke_etag: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Accepts a proposal to update a Network Connectivity Center spoke in a hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_accept_spoke_update(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptSpokeUpdateRequest.html( name="name_value", spoke_uri="spoke_uri_value", spoke_etag="spoke_etag_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_accept_spoke_update(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptSpokeUpdateRequest, dict]` The request object. The request for HubService.AcceptSpokeUpdate. | | `name` | `str` Required. The name of the hub to accept spoke update. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_uri` | `str` Required. The URI of the spoke to accept update. This corresponds to the `spoke_uri` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_etag` | `str` Required. The etag of the spoke to accept update. This corresponds to the `spoke_etag` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [AcceptSpokeUpdateResponse](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.AcceptSpokeUpdateResponse) The response for HubService.AcceptSpokeUpdate. | ### cancel_operation cancel_operation( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.CancelOperationRequest` `` The request object. Request message for `CancelOperation` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### common_billing_account_path common_billing_account_path(billing_account: str) -> str Returns a fully-qualified billing_account string. ### common_folder_path common_folder_path(folder: str) -> str Returns a fully-qualified folder string. ### common_location_path common_location_path(project: str, location: str) -> str Returns a fully-qualified location string. ### common_organization_path common_organization_path(organization: str) -> str Returns a fully-qualified organization string. ### common_project_path common_project_path(project: str) -> str Returns a fully-qualified project string. ### create_gateway_advertised_route create_gateway_advertised_route( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.CreateGatewayAdvertisedRouteRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, gateway_advertised_route: typing.Optional[ google.cloud.networkconnectivity_v1beta.types.hub.GatewayAdvertisedRoute ] = None, gateway_advertised_route_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Create a GatewayAdvertisedRoute # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_create_gateway_advertised_route(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateGatewayAdvertisedRouteRequest.html( parent="parent_value", gateway_advertised_route_id="gateway_advertised_route_id_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_create_gateway_advertised_route(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateGatewayAdvertisedRouteRequest, dict]` The request object. The request for HubService.CreateGatewayAdvertisedRoute. | | `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. | | `gateway_advertised_route` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GatewayAdvertisedRoute` Required. Initial values for the new gateway advertised route. This corresponds to the `gateway_advertised_route` field on the `request` instance; if `request` is provided, this should not be set. | | `gateway_advertised_route_id` | `str` Required. Unique id for the route to create. This corresponds to the `gateway_advertised_route_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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [GatewayAdvertisedRoute](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GatewayAdvertisedRoute) A gateway advertised route is a route that a gateway spoke advertises somewhere. | ### create_hub create_hub( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.CreateHubRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, hub: typing.Optional[google.cloud.networkconnectivity_v1beta.types.hub.Hub] = None, hub_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Creates a new Network Connectivity Center hub in the specified project. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_create_hub(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateHubRequest.html( parent="parent_value", hub_id="hub_id_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_create_hub(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateHubRequest, dict]` The request object. Request for 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` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.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` Required. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Hub](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Hub) A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project. | ### create_spoke create_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.CreateSpokeRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, spoke: typing.Optional[ google.cloud.networkconnectivity_v1beta.types.hub.Spoke ] = None, spoke_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Creates a Network Connectivity Center spoke. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_create_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateSpokeRequest.html( parent="parent_value", spoke_id="spoke_id_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_create_spoke(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.CreateSpokeRequest, dict]` The request object. The request for 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` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.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` Required. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Spoke](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Spoke) A Network Connectivity Center spoke represents one or more network connectivity resources. 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 - linked_vpc_network | ### delete_gateway_advertised_route delete_gateway_advertised_route( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.DeleteGatewayAdvertisedRouteRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Delete a GatewayAdvertisedRoute # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_delete_gateway_advertised_route(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteGatewayAdvertisedRouteRequest.html( name="name_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_delete_gateway_advertised_route(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteGatewayAdvertisedRouteRequest, dict]` The request object. Request for HubService.DeleteGatewayAdvertisedRoute method. | | `name` | `str` Required. The name of the gateway advertised route 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be `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); } | ### delete_hub delete_hub( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.DeleteHubRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Deletes a Network Connectivity Center hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_delete_hub(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteHubRequest.html( name="name_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_delete_hub(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteHubRequest, dict]` The request object. The request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be `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); } | ### delete_operation delete_operation( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.DeleteOperationRequest` `` The request object. Request message for `DeleteOperation` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### delete_spoke delete_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.DeleteSpokeRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Deletes a Network Connectivity Center spoke. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_delete_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteSpokeRequest.html( name="name_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_delete_spoke(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.DeleteSpokeRequest, dict]` The request object. The request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be `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); } | ### from_service_account_file from_service_account_file(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `HubServiceClient` | The constructed client. | ### from_service_account_info from_service_account_info(info: dict, *args, **kwargs) Creates an instance of this client using the provided credentials info. | **Parameter** || |---|---| | **Name** | **Description** | | `info` | `dict` The service account private key info. | | **Returns** || |---|---| | **Type** | **Description** | | `HubServiceClient` | The constructed client. | ### from_service_account_json from_service_account_json(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `HubServiceClient` | The constructed client. | ### gateway_advertised_route_path gateway_advertised_route_path( project: str, location: str, spoke: str, gateway_advertised_route: str ) -> str Returns a fully-qualified gateway_advertised_route string. ### get_gateway_advertised_route get_gateway_advertised_route( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetGatewayAdvertisedRouteRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.GatewayAdvertisedRoute Get a GatewayAdvertisedRoute # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_gateway_advertised_route(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetGatewayAdvertisedRouteRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_gateway_advertised_route(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetGatewayAdvertisedRouteRequest, dict]` The request object. The request for HubService.GetGatewayAdvertisedRoute. | | `name` | `str` Required. The name of the gateway advertised route 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GatewayAdvertisedRoute` | A gateway advertised route is a route that a gateway spoke advertises somewhere. | ### get_group get_group( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetGroupRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.Group Gets details about a Network Connectivity Center group. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_group(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetGroupRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_group(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetGroupRequest, dict]` The request object. The request for HubService.GetGroup. | | `name` | `str` Required. The name of the route table 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Group` | A group represents a subset of spokes attached to a hub. | ### get_hub get_hub( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetHubRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.Hub Gets details about a Network Connectivity Center hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_hub(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetHubRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_hub(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetHubRequest, dict]` The request object. Request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Hub` | A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project. | ### get_iam_policy get_iam_policy( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.policy_pb2.Policy Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.iam_policy_pb2.GetIamPolicyRequest` `` The request object. Request message for `GetIamPolicy` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.policy_pb2.Policy` `` | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. \*\*JSON Example\*\* :: { "bindings": \[ { "role": "roles/resourcemanager.organizationAdmin", "members": \[ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" \] }, { "role": "roles/resourcemanager.organizationViewer", "members": \["user:eve@example.com"\], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time \< timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" \]="" }="" \*\*yaml="" example\*\*="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time=""\>\< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""\>`IAM developer's guide `__. | ### get_location get_location( request: typing.Optional[ typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.location.locations_pb2.Location Gets information about a location. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.location_pb2.GetLocationRequest` `` The request object. Request message for `GetLocation` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.location_pb2.Location` `` | Location object. | ### get_mtls_endpoint_and_cert_source get_mtls_endpoint_and_cert_source( client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, ) Deprecated. Return the API endpoint and client cert source for mutual TLS. The client cert source is determined in the following order: (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the client cert source is None. (2) if `client_options.client_cert_source` is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None. The API endpoint is determined in the following order: (1) if `client_options.api_endpoint` if provided, use the provided one. (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint. More details can be found at . | **Parameter** || |---|---| | **Name** | **Description** | | `client_options` | `google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If any errors happen. | | **Returns** || |---|---| | **Type** | **Description** | | `Tuple[str, Callable[[], Tuple[bytes, bytes]]]` | returns the API endpoint and the client cert source to use. | ### get_operation get_operation( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.Operation Gets the latest state of a long-running operation. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.GetOperationRequest` `` The request object. Request message for `GetOperation` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.operations_pb2.Operation` `` | An `Operation` object. | ### get_route get_route( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetRouteRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.Route Gets details about the specified route. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_route(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetRouteRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_route(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetRouteRequest, dict]` The request object. The request for HubService.GetRoute. | | `name` | `str` Required. The name of the route 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Route` | A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes. | ### get_route_table get_route_table( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetRouteTableRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.RouteTable Gets details about a Network Connectivity Center route table. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_route_table(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetRouteTableRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_route_table(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetRouteTableRequest, dict]` The request object. The request for HubService.GetRouteTable. | | `name` | `str` Required. The name of the route table 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### get_spoke get_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.GetSpokeRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.types.hub.Spoke Gets details about a Network Connectivity Center spoke. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_get_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetSpokeRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_get_spoke(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GetSpokeRequest, dict]` The request object. The request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Spoke` | A Network Connectivity Center spoke represents one or more network connectivity resources. 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 - linked_vpc_network | ### group_path group_path(project: str, hub: str, group: str) -> str Returns a fully-qualified group string. ### hub_path hub_path(project: str, hub: str) -> str Returns a fully-qualified hub string. ### hub_route_path hub_route_path(project: str, hub: str, route_table: str, route: str) -> str Returns a fully-qualified hub_route string. ### instance_path instance_path(project: str, zone: str, instance: str) -> str Returns a fully-qualified instance string. ### interconnect_attachment_path interconnect_attachment_path(project: str, region: str, resource_id: str) -> str Returns a fully-qualified interconnect_attachment string. ### list_gateway_advertised_routes list_gateway_advertised_routes( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListGatewayAdvertisedRoutesRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListGatewayAdvertisedRoutesPager ) List GatewayAdvertisedRoutes # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_gateway_advertised_routes(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListGatewayAdvertisedRoutesRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_gateway_advertised_routes(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListGatewayAdvertisedRoutesRequest, dict]` The request object. The request for HubService.ListGatewayAdvertisedRoutes. | | `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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListGatewayAdvertisedRoutesPager` | Response for HubService.ListGatewayAdvertisedRoutes method. Iterating over this object will yield results and resolve additional pages automatically. | ### list_groups list_groups( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListGroupsRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListGroupsPager ) Lists groups in a given hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_groups(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListGroupsRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_groups(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListGroupsRequest, dict]` The request object. Request for HubService.ListGroups 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListGroupsPager` | Response for HubService.ListGroups method. Iterating over this object will yield results and resolve additional pages automatically. | ### list_hub_spokes list_hub_spokes( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListHubSpokesRequest, dict ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListHubSpokesPager ) Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_hub_spokes(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListHubSpokesRequest.html( name="name_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_hub_spokes(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListHubSpokesRequest, dict]` The request object. The request for HubService.ListHubSpokes. | | `name` | `str` Required. The name of the hub. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListHubSpokesPager` | The response for HubService.ListHubSpokes. Iterating over this object will yield results and resolve additional pages automatically. | ### list_hubs list_hubs( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListHubsRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListHubsPager Lists the Network Connectivity Center hubs associated with a given project. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_hubs(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListHubsRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_hubs(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListHubsRequest, dict]` The request object. Request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListHubsPager` | Response for HubService.ListHubs method. Iterating over this object will yield results and resolve additional pages automatically. | ### list_locations list_locations( request: typing.Optional[ typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.location.locations_pb2.ListLocationsResponse Lists information about the supported locations for this service. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.location_pb2.ListLocationsRequest` `` The request object. Request message for `ListLocations` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.location_pb2.ListLocationsResponse` `` | Response message for `ListLocations` method. | ### list_operations list_operations( request: typing.Optional[ typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.ListOperationsResponse Lists operations that match the specified filter in the request. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.operations_pb2.ListOperationsRequest` `` The request object. Request message for `ListOperations` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.operations_pb2.ListOperationsResponse` `` | Response message for `ListOperations` method. | ### list_route_tables list_route_tables( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListRouteTablesRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListRouteTablesPager ) Lists route tables in a given hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_route_tables(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListRouteTablesRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_route_tables(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListRouteTablesRequest, dict]` The request object. Request for HubService.ListRouteTables 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListRouteTablesPager` | Response for HubService.ListRouteTables method. Iterating over this object will yield results and resolve additional pages automatically. | ### list_routes list_routes( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListRoutesRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListRoutesPager ) Lists routes in a given route table. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_routes(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListRoutesRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_routes(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListRoutesRequest, dict]` The request object. Request for HubService.ListRoutes 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListRoutesPager` | Response for HubService.ListRoutes method. Iterating over this object will yield results and resolve additional pages automatically. | ### list_spokes list_spokes( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.ListSpokesRequest, dict ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListSpokesPager ) Lists the Network Connectivity Center spokes in a specified project and location. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_list_spokes(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListSpokesRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_list_spokes(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.ListSpokesRequest, dict]` The request object. The request for 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.ListSpokesPager` | The response for HubService.ListSpokes. Iterating over this object will yield results and resolve additional pages automatically. | ### network_path network_path(project: str, resource_id: str) -> str Returns a fully-qualified network string. ### parse_common_billing_account_path parse_common_billing_account_path(path: str) -> typing.Dict[str, str] Parse a billing_account path into its component segments. ### parse_common_folder_path parse_common_folder_path(path: str) -> typing.Dict[str, str] Parse a folder path into its component segments. ### parse_common_location_path parse_common_location_path(path: str) -> typing.Dict[str, str] Parse a location path into its component segments. ### parse_common_organization_path parse_common_organization_path(path: str) -> typing.Dict[str, str] Parse a organization path into its component segments. ### parse_common_project_path parse_common_project_path(path: str) -> typing.Dict[str, str] Parse a project path into its component segments. ### parse_gateway_advertised_route_path parse_gateway_advertised_route_path(path: str) -> typing.Dict[str, str] Parses a gateway_advertised_route path into its component segments. ### parse_group_path parse_group_path(path: str) -> typing.Dict[str, str] Parses a group path into its component segments. ### parse_hub_path parse_hub_path(path: str) -> typing.Dict[str, str] Parses a hub path into its component segments. ### parse_hub_route_path parse_hub_route_path(path: str) -> typing.Dict[str, str] Parses a hub_route path into its component segments. ### parse_instance_path parse_instance_path(path: str) -> typing.Dict[str, str] Parses a instance path into its component segments. ### parse_interconnect_attachment_path parse_interconnect_attachment_path(path: str) -> typing.Dict[str, str] Parses a interconnect_attachment path into its component segments. ### parse_network_path parse_network_path(path: str) -> typing.Dict[str, str] Parses a network path into its component segments. ### parse_route_table_path parse_route_table_path(path: str) -> typing.Dict[str, str] Parses a route_table path into its component segments. ### parse_sac_attachment_path parse_sac_attachment_path(path: str) -> typing.Dict[str, str] Parses a sac_attachment path into its component segments. ### parse_spoke_path parse_spoke_path(path: str) -> typing.Dict[str, str] Parses a spoke path into its component segments. ### parse_vpn_tunnel_path parse_vpn_tunnel_path(path: str) -> typing.Dict[str, str] Parses a vpn_tunnel path into its component segments. ### query_hub_status query_hub_status( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.QueryHubStatusRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.QueryHubStatusPager ) Query the Private Service Connect propagation status of a Network Connectivity Center hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_query_hub_status(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.QueryHubStatusRequest.html( name="name_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_query_hub_status(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.QueryHubStatusRequest, dict]` The request object. The request for HubService.QueryHubStatus. | | `name` | `str` Required. The name of the hub. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.pagers.QueryHubStatusPager` | The response for HubService.QueryHubStatus. Iterating over this object will yield results and resolve additional pages automatically. | ### reject_hub_spoke reject_hub_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.RejectHubSpokeRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, spoke_uri: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Rejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_reject_hub_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectHubSpokeRequest.html( name="name_value", spoke_uri="spoke_uri_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_reject_hub_spoke(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectHubSpokeRequest, dict]` The request object. The request for HubService.RejectHubSpoke. | | `name` | `str` Required. The name of the hub from which to reject the spoke. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_uri` | `str` Required. The URI of the spoke to reject from the hub. This corresponds to the `spoke_uri` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [RejectHubSpokeResponse](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectHubSpokeResponse) The response for HubService.RejectHubSpoke. | ### reject_spoke_update reject_spoke_update( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.RejectSpokeUpdateRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, spoke_uri: typing.Optional[str] = None, spoke_etag: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Rejects a proposal to update a Network Connectivity Center spoke in a hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_reject_spoke_update(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectSpokeUpdateRequest.html( name="name_value", spoke_uri="spoke_uri_value", spoke_etag="spoke_etag_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_reject_spoke_update(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectSpokeUpdateRequest, dict]` The request object. The request for HubService.RejectSpokeUpdate. | | `name` | `str` Required. The name of the hub to reject spoke update. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_uri` | `str` Required. The URI of the spoke to reject update. This corresponds to the `spoke_uri` field on the `request` instance; if `request` is provided, this should not be set. | | `spoke_etag` | `str` Required. The etag of the spoke to reject update. This corresponds to the `spoke_etag` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [RejectSpokeUpdateResponse](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.RejectSpokeUpdateResponse) The response for HubService.RejectSpokeUpdate. | ### route_table_path route_table_path(project: str, hub: str, route_table: str) -> str Returns a fully-qualified route_table string. ### sac_attachment_path sac_attachment_path(project: str, location: str, sac_attachment: str) -> str Returns a fully-qualified sac_attachment string. ### set_iam_policy set_iam_policy( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.policy_pb2.Policy Sets the IAM access control policy on the specified function. Replaces any existing policy. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.iam_policy_pb2.SetIamPolicyRequest` `` The request object. Request message for `SetIamPolicy` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.policy_pb2.Policy` `` | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. \*\*JSON Example\*\* :: { "bindings": \[ { "role": "roles/resourcemanager.organizationAdmin", "members": \[ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" \] }, { "role": "roles/resourcemanager.organizationViewer", "members": \["user:eve@example.com"\], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time \< timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" \]="" }="" \*\*yaml="" example\*\*="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time=""\>\< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""\>`IAM developer's guide `__. | ### spoke_path spoke_path(project: str, location: str, spoke: str) -> str Returns a fully-qualified spoke string. ### test_iam_permissions test_iam_permissions( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse Tests the specified IAM permissions against the IAM access control policy for a function. If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error. | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `` `.iam_policy_pb2.TestIamPermissionsRequest` `` The request object. Request message for `TestIamPermissions` method. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `` `.iam_policy_pb2.TestIamPermissionsResponse` `` | Response message for `TestIamPermissions` method. | ### update_gateway_advertised_route update_gateway_advertised_route( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.UpdateGatewayAdvertisedRouteRequest, dict, ] ] = None, *, gateway_advertised_route: typing.Optional[ google.cloud.networkconnectivity_v1beta.types.hub.GatewayAdvertisedRoute ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Update a GatewayAdvertisedRoute # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_update_gateway_advertised_route(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateGatewayAdvertisedRouteRequest.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_update_gateway_advertised_route(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateGatewayAdvertisedRouteRequest, dict]` The request object. The request for HubService.UpdateGatewayAdvertisedRoute. | | `gateway_advertised_route` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GatewayAdvertisedRoute` Required. The gateway advertised route to update. The gateway advertised route's `name` field is used to identify the gateway advertised route to update. Format: `projects/{project}/locations/{location}/spokes/{spoke}/gatewayAdvertisedRoutes/{gatewayAdvertisedRoute}` This corresponds to the `gateway_advertised_route` 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 group, 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [GatewayAdvertisedRoute](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.GatewayAdvertisedRoute) A gateway advertised route is a route that a gateway spoke advertises somewhere. | ### update_group update_group( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.UpdateGroupRequest, dict ] ] = None, *, group: typing.Optional[ google.cloud.networkconnectivity_v1beta.types.hub.Group ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates the parameters of a Network Connectivity Center group. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_update_group(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateGroupRequest.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_update_group(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateGroupRequest, dict]` The request object. Request for HubService.UpdateGroup method. | | `group` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Group` Required. The state that the group should be in after the update. This corresponds to the `group` 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 group, 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Group](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Group) A group represents a subset of spokes attached to a hub. | ### update_hub update_hub( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.UpdateHubRequest, dict ] ] = None, *, hub: typing.Optional[google.cloud.networkconnectivity_v1beta.types.hub.Hub] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates the description and/or labels of a Network Connectivity Center hub. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_update_hub(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateHubRequest.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_update_hub(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateHubRequest, dict]` The request object. Request for HubService.UpdateHub method. | | `hub` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Hub](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Hub) A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project. | ### update_spoke update_spoke( request: typing.Optional[ typing.Union[ google.cloud.networkconnectivity_v1beta.types.hub.UpdateSpokeRequest, dict ] ] = None, *, spoke: typing.Optional[ google.cloud.networkconnectivity_v1beta.types.hub.Spoke ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates the parameters of a Network Connectivity Center spoke. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import networkconnectivity_v1beta def sample_update_spoke(): # Create a client client = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html() # Initialize request argument(s) request = networkconnectivity_v1beta.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateSpokeRequest.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.services.hub_service.HubServiceClient.html#google_cloud_networkconnectivity_v1beta_services_hub_service_HubServiceClient_update_spoke(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.UpdateSpokeRequest, dict]` The request object. Request for HubService.UpdateSpoke method. | | `spoke` | `https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Spoke](https://docs.cloud.google.com/python/docs/reference/networkconnectivity/latest/google.cloud.networkconnectivity_v1beta.types.Spoke) A Network Connectivity Center spoke represents one or more network connectivity resources. 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 - linked_vpc_network | ### vpn_tunnel_path vpn_tunnel_path(project: str, region: str, resource_id: str) -> str Returns a fully-qualified vpn_tunnel string.