Class HubServiceClient (0.4.0)

HubServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

transport

Returns the transport used by the client instance.

Returns
Type	Description
`HubServiceTransport`	The transport used by the client instance.

Methods

HubServiceClient

HubServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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`	`Union[str, HubServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_hub

create_hub(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateHubRequest] = None, *, parent: Optional[str] = None, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, hub_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Hub in a given project and location.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.CreateHubRequest` The request object. Request for HubService.CreateHub method.
`parent`	`str` Required. The parent resource's name of the Hub. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`hub`	`google.cloud.networkconnectivity_v1alpha1.types.Hub` Required. Initial values for a new Hub. This corresponds to the `hub` field on the `request` instance; if `request` is provided, this should not be set.
`hub_id`	`str` Optional. Unique id for the Hub to create. This corresponds to the `hub_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Hub 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. Following is the resource message of a hub.

create_spoke

create_spoke(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateSpokeRequest] = None, *, parent: Optional[str] = None, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, spoke_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Spoke in a given project and location.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.CreateSpokeRequest` The request object. The request for HubService.CreateSpoke.
`parent`	`str` Required. The parent's resource name of the Spoke. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`spoke`	`google.cloud.networkconnectivity_v1alpha1.types.Spoke` Required. Initial values for a new Hub. This corresponds to the `spoke` field on the `request` instance; if `request` is provided, this should not be set.
`spoke_id`	`str` Optional. Unique id for the Spoke to create. This corresponds to the `spoke_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Spoke A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.

delete_hub

delete_hub(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteHubRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Hub.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.DeleteHubRequest` 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, str]]` Strings which should be sent along with the request as metadata.

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); } The JSON representation for Empty is empty JSON object {}.

delete_spoke

delete_spoke(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteSpokeRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Spoke.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.DeleteSpokeRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

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.

get_hub

get_hub(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.GetHubRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Hub.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.GetHubRequest` The request object. Request for HubService.GetHub method.
`name`	`str` Required. Name of the Hub resource to get. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.networkconnectivity_v1alpha1.types.Hub`	Network Connectivity Center is a hub- nd-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model. Following is the resource message of a hub.

get_spoke

get_spoke(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.GetSpokeRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Spoke.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.GetSpokeRequest` The request object. The request for HubService.GetSpoke.
`name`	`str` Required. The name of Spoke resource. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.networkconnectivity_v1alpha1.types.Spoke`	A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.

hub_path

hub_path(project: str, hub: str)

Returns a fully-qualified hub string.

instance_path

instance_path(project: str, zone: str, instance: str)

Returns a fully-qualified instance string.

interconnect_attachment_path

interconnect_attachment_path(project: str, region: str, resource_id: str)

Returns a fully-qualified interconnect_attachment string.

list_hubs

list_hubs(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Hubs in a given project and location.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.ListHubsRequest` 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, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsPager`	Response for HubService.ListHubs method. Iterating over this object will yield results and resolve additional pages automatically.

list_spokes

list_spokes(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Spokes in a given project and location.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.ListSpokesRequest` The request object. The request for HubService.ListSpokes.
`parent`	`str` Required. The parent's resource name. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesPager`	The response for HubService.ListSpokes. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_hub_path

parse_hub_path(path: str)

Parses a hub path into its component segments.

parse_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.

parse_interconnect_attachment_path

parse_interconnect_attachment_path(path: str)

Parses a interconnect_attachment path into its component segments.

parse_spoke_path

parse_spoke_path(path: str)

Parses a spoke path into its component segments.

parse_vpn_tunnel_path

parse_vpn_tunnel_path(path: str)

Parses a vpn_tunnel path into its component segments.

spoke_path

spoke_path(project: str, location: str, spoke: str)

Returns a fully-qualified spoke string.

update_hub

update_hub(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateHubRequest] = None, *, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the parameters of a single Hub.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.UpdateHubRequest` The request object. Request for HubService.UpdateHub method.
`hub`	`google.cloud.networkconnectivity_v1alpha1.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. Field mask is used to specify the fields to be overwritten in the Hub resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Hub 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. Following is the resource message of a hub.

update_spoke

update_spoke(request: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateSpokeRequest] = None, *, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the parameters of a single Spoke.

Parameters
Name	Description
`request`	`google.cloud.networkconnectivity_v1alpha1.types.UpdateSpokeRequest` The request object. Request for HubService.UpdateSpoke method.
`spoke`	`google.cloud.networkconnectivity_v1alpha1.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. Field mask is used to specify the fields to be overwritten in the Spoke resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Spoke A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.

vpn_tunnel_path

vpn_tunnel_path(project: str, region: str, resource_id: str)

Returns a fully-qualified vpn_tunnel string.