HubServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.networkconnectivity_v1.services.hub_service.transports.base.HubServiceTransport] = 'grpc_asyncio', 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.
Inheritance
builtins.object > HubServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
HubServiceTransport | The transport used by the client instance. |
Methods
HubServiceAsyncClient
HubServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.networkconnectivity_v1.services.hub_service.transports.base.HubServiceTransport] = 'grpc_asyncio', 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.
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 |
ClientOptions
Custom options for the client. It won't take effect if a |
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[Union[google.cloud.networkconnectivity_v1.types.hub.CreateHubRequest, dict]] = None, *, parent: Optional[str] = None, hub: Optional[google.cloud.networkconnectivity_v1.types.hub.Hub] = None, hub_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new hub in the specified project.
from google.cloud import networkconnectivity_v1
async def sample_create_hub():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.CreateHubRequest(
parent="parent_value",
hub_id="hub_id_value",
)
# Make the request
operation = client.create_hub(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.CreateHubRequest, dict]
The request object. Request for HubService.CreateHub method. |
parent |
`str`
Required. The parent resource. This corresponds to the |
hub |
Hub
Required. The initial values for a new hub. This corresponds to the |
hub_id |
`str`
Required. A unique identifier for the hub. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Hub A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the data transfer feature, the resources associated with those spokes must all reside in the same VPC network. Spokes that do not use data transfer can be associated with any VPC network in your project. |
create_spoke
create_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.CreateSpokeRequest, dict]] = None, *, parent: Optional[str] = None, spoke: Optional[google.cloud.networkconnectivity_v1.types.hub.Spoke] = None, spoke_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a spoke in the specified project and location.
from google.cloud import networkconnectivity_v1
async def sample_create_spoke():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.CreateSpokeRequest(
parent="parent_value",
spoke_id="spoke_id_value",
)
# Make the request
operation = client.create_spoke(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.CreateSpokeRequest, dict]
The request object. The request for HubService.CreateSpoke. |
parent |
`str`
Required. The parent resource. This corresponds to the |
spoke |
Spoke
Required. The initial values for a new spoke. This corresponds to the |
spoke_id |
`str`
Required. Unique id for the spoke to create. This corresponds to the |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Spoke A spoke represents a connection between your Google Cloud network resources and a non-Google-Cloud network. When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields: - linked_vpn_tunnels - linked_interconnect_attachments - linked_router_appliance_instances |
delete_hub
delete_hub(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.DeleteHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified hub.
from google.cloud import networkconnectivity_v1
async def sample_delete_hub():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.DeleteHubRequest(
name="name_value",
)
# Make the request
operation = client.delete_hub(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | 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[Union[google.cloud.networkconnectivity_v1.types.hub.DeleteSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified spoke.
from google.cloud import networkconnectivity_v1
async def sample_delete_spoke():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.DeleteSpokeRequest(
name="name_value",
)
# Make the request
operation = client.delete_spoke(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | 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 {}. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
HubServiceAsyncClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
HubServiceAsyncClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
HubServiceAsyncClient | The constructed client. |
get_hub
get_hub(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.GetHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details about the specified hub.
from google.cloud import networkconnectivity_v1
async def sample_get_hub():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.GetHubRequest(
name="name_value",
)
# Make the request
response = await client.get_hub(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.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 |
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. |
Type | Description |
google.cloud.networkconnectivity_v1.types.Hub | A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the data transfer feature, the resources associated with those spokes must all reside in the same VPC network. Spokes that do not use data transfer can be associated with any VPC network in your project. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
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 variabel 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 https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_spoke
get_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.GetSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details about the specified spoke.
from google.cloud import networkconnectivity_v1
async def sample_get_spoke():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.GetSpokeRequest(
name="name_value",
)
# Make the request
response = await client.get_spoke(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.GetSpokeRequest, dict]
The request object. The request for HubService.GetSpoke. |
name |
`str`
Required. The name of the spoke resource. This corresponds to the |
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. |
Type | Description |
google.cloud.networkconnectivity_v1.types.Spoke | A spoke represents a connection between your Google Cloud network resources and a non-Google-Cloud network. When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields: - linked_vpn_tunnels - linked_interconnect_attachments - linked_router_appliance_instances |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
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[Union[google.cloud.networkconnectivity_v1.types.hub.ListHubsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists hubs in a given project.
from google.cloud import networkconnectivity_v1
async def sample_list_hubs():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.ListHubsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_hubs(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.ListHubsRequest, dict]
The request object. Request for HubService.ListHubs method. |
parent |
`str`
Required. The parent resource's name. This corresponds to the |
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. |
Type | Description |
google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListHubsAsyncPager | Response for HubService.ListHubs method. Iterating over this object will yield results and resolve additional pages automatically. |
list_spokes
list_spokes(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.ListSpokesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists the spokes in the specified project and location.
from google.cloud import networkconnectivity_v1
async def sample_list_spokes():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.ListSpokesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_spokes(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.ListSpokesRequest, dict]
The request object. The request for HubService.ListSpokes. |
parent |
`str`
Required. The parent resource. This corresponds to the |
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. |
Type | Description |
google.cloud.networkconnectivity_v1.services.hub_service.pagers.ListSpokesAsyncPager | 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)
Returns a fully-qualified network string.
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_network_path
parse_network_path(path: str)
Parses a network 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[Union[google.cloud.networkconnectivity_v1.types.hub.UpdateHubRequest, dict]] = None, *, hub: Optional[google.cloud.networkconnectivity_v1.types.hub.Hub] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the description and/or labels of the specified hub.
from google.cloud import networkconnectivity_v1
async def sample_update_hub():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.UpdateHubRequest(
)
# Make the request
operation = client.update_hub(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.UpdateHubRequest, dict]
The request object. Request for HubService.UpdateHub method. |
hub |
Hub
Required. The state that the hub should be in after the update. This corresponds to the |
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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Hub A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the data transfer feature, the resources associated with those spokes must all reside in the same VPC network. Spokes that do not use data transfer can be associated with any VPC network in your project. |
update_spoke
update_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1.types.hub.UpdateSpokeRequest, dict]] = None, *, spoke: Optional[google.cloud.networkconnectivity_v1.types.hub.Spoke] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of the specified spoke.
from google.cloud import networkconnectivity_v1
async def sample_update_spoke():
# Create a client
client = networkconnectivity_v1.HubServiceAsyncClient()
# Initialize request argument(s)
request = networkconnectivity_v1.UpdateSpokeRequest(
)
# Make the request
operation = client.update_spoke(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.networkconnectivity_v1.types.UpdateSpokeRequest, dict]
The request object. Request for HubService.UpdateSpoke method. |
spoke |
Spoke
Required. The state that the spoke should be in after the update. This corresponds to the |
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 |
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. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Spoke A spoke represents a connection between your Google Cloud network resources and a non-Google-Cloud network. When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields: - linked_vpn_tunnels - linked_interconnect_attachments - linked_router_appliance_instances |
vpn_tunnel_path
vpn_tunnel_path(project: str, region: str, resource_id: str)
Returns a fully-qualified vpn_tunnel string.