As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

HubService

class google.cloud.networkconnectivity_v1alpha1.services.hub_service.HubServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport, typing.Callable[[...], google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]

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.

Instantiates the hub service async client.

Parameters

  • 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 to use. 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 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateHubRequest, dict]] = None, *, parent: Optional[str] = None, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, hub_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Creates a new Hub in a given 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_v1alpha1

async def sample_create_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.CreateHubRequest(
        parent="parent_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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.CreateHubRequest, dict]]) – The request object. Request for [HubService.CreateHub][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.networkconnectivity_v1alpha1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

async create_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateSpokeRequest, dict]] = None, *, parent: Optional[str] = None, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, spoke_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Creates a new Spoke in a given 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_v1alpha1

async def sample_create_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.CreateSpokeRequest(
        parent="parent_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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.CreateSpokeRequest, dict]]) – The request object. The request for [HubService.CreateSpoke][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

async delete_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Deletes a single 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_v1alpha1

async def sample_delete_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.DeleteHubRequest, dict]]) – The request object. The request for [HubService.DeleteHub][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Deletes a single 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_v1alpha1

async def sample_delete_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.DeleteSpokeRequest, dict]]) – The request object. The request for [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceAsyncClient

async get_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.GetHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.types.hub.Hub[source]

Gets details of a single 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_v1alpha1

async def sample_get_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.GetHubRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_hub(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.GetHubRequest, dict]]) – The request object. Request for [HubService.GetHub][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

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.

Return type

google.cloud.networkconnectivity_v1alpha1.types.Hub

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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 https://google.aip.dev/auth/4114.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.GetSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke[source]

Gets details of a single 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_v1alpha1

async def sample_get_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.GetSpokeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_spoke(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.GetSpokeRequest, dict]]) – The request object. The request for [HubService.GetSpoke][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

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.

Return type

google.cloud.networkconnectivity_v1alpha1.types.Spoke

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

static hub_path(project: str, hub: str) → str

Returns a fully-qualified hub string.

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

Returns a fully-qualified instance string.

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

Returns a fully-qualified interconnect_attachment string.

async list_hubs(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsAsyncPager[source]

Lists Hubs in a given 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_v1alpha1

async def sample_list_hubs():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.ListHubsRequest, dict]]) – The request object. Request for [HubService.ListHubs][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

Response for [HubService.ListHubs][google.cloud.networkconnectivity.v1alpha1.HubService.ListHubs] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsAsyncPager

async list_spokes(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesAsyncPager[source]

Lists Spokes in a given 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_v1alpha1

async def sample_list_spokes():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.ListSpokesRequest, dict]]) – The request object. The request for [HubService.ListSpokes][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

The response for [HubService.ListSpokes][google.cloud.networkconnectivity.v1alpha1.HubService.ListSpokes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_hub_path(path: str) → Dict[str, str]

Parses a hub path into its component segments.

static parse_instance_path(path: str) → Dict[str, str]

Parses a instance path into its component segments.

static parse_interconnect_attachment_path(path: str) → Dict[str, str]

Parses a interconnect_attachment path into its component segments.

static parse_spoke_path(path: str) → Dict[str, str]

Parses a spoke path into its component segments.

static parse_vpn_tunnel_path(path: str) → Dict[str, str]

Parses a vpn_tunnel path into its component segments.

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

Returns a fully-qualified spoke string.

property transport: google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

HubServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateHubRequest, dict]] = None, *, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Updates the parameters of a single 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_v1alpha1

async def sample_update_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.UpdateHubRequest, dict]]) – The request object. Request for [HubService.UpdateHub][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.networkconnectivity_v1alpha1.types.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.

Return type

google.api_core.operation_async.AsyncOperation

async update_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateSpokeRequest, dict]] = None, *, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Updates the parameters of a single 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_v1alpha1

async def sample_update_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceAsyncClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.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)
Parameters

  • request (Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.UpdateSpokeRequest, dict]]) – The request object. Request for [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1alpha1.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_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified vpn_tunnel string.

class google.cloud.networkconnectivity_v1alpha1.services.hub_service.HubServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport, typing.Callable[[...], google.cloud.networkconnectivity_v1alpha1.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 object>)[source]

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.

Instantiates the hub service client.

Parameters

  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

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!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

create_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateHubRequest, dict]] = None, *, parent: Optional[str] = None, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, hub_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Creates a new Hub in a given 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_v1alpha1

def sample_create_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.CreateHubRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_hub(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.CreateHubRequest, dict]) – The request object. Request for [HubService.CreateHub][google.cloud.networkconnectivity.v1alpha1.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.networkconnectivity_v1alpha1.types.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.

Return type

google.api_core.operation.Operation

create_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.CreateSpokeRequest, dict]] = None, *, parent: Optional[str] = None, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, spoke_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Creates a new Spoke in a given 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_v1alpha1

def sample_create_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.CreateSpokeRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_spoke(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.CreateSpokeRequest, dict]) – The request object. The request for [HubService.CreateSpoke][google.cloud.networkconnectivity.v1alpha1.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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

delete_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Deletes a single 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_v1alpha1

def sample_delete_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.DeleteHubRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_hub(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.DeleteHubRequest, dict]) – The request object. The request for [HubService.DeleteHub][google.cloud.networkconnectivity.v1alpha1.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

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);

}

Return type

google.api_core.operation.Operation

delete_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.DeleteSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Deletes a single 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_v1alpha1

def sample_delete_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.DeleteSpokeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_spoke(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.DeleteSpokeRequest, dict]) – The request object. The request for [HubService.DeleteSpoke][google.cloud.networkconnectivity.v1alpha1.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

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);

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

HubServiceClient

get_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.GetHubRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.types.hub.Hub[source]

Gets details of a single 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_v1alpha1

def sample_get_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.GetHubRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_hub(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.GetHubRequest, dict]) – The request object. Request for [HubService.GetHub][google.cloud.networkconnectivity.v1alpha1.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

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.

Return type

google.cloud.networkconnectivity_v1alpha1.types.Hub

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

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 https://google.aip.dev/auth/4114.

Parameters

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.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.GetSpokeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke[source]

Gets details of a single 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_v1alpha1

def sample_get_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.GetSpokeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_spoke(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.GetSpokeRequest, dict]) – The request object. The request for [HubService.GetSpoke][google.cloud.networkconnectivity.v1alpha1.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

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.

Return type

google.cloud.networkconnectivity_v1alpha1.types.Spoke

static hub_path(project: str, hub: str) → str[source]

Returns a fully-qualified hub string.

static instance_path(project: str, zone: str, instance: str) → str[source]

Returns a fully-qualified instance string.

static interconnect_attachment_path(project: str, region: str, resource_id: str) → str[source]

Returns a fully-qualified interconnect_attachment string.

list_hubs(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsPager[source]

Lists Hubs in a given 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_v1alpha1

def sample_list_hubs():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.ListHubsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_hubs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.ListHubsRequest, dict]) – The request object. Request for [HubService.ListHubs][google.cloud.networkconnectivity.v1alpha1.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

Response for [HubService.ListHubs][google.cloud.networkconnectivity.v1alpha1.HubService.ListHubs] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsPager

list_spokes(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesPager[source]

Lists Spokes in a given 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_v1alpha1

def sample_list_spokes():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.ListSpokesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_spokes(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.ListSpokesRequest, dict]) – The request object. The request for [HubService.ListSpokes][google.cloud.networkconnectivity.v1alpha1.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

The response for [HubService.ListSpokes][google.cloud.networkconnectivity.v1alpha1.HubService.ListSpokes].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_hub_path(path: str) → Dict[str, str][source]

Parses a hub path into its component segments.

static parse_instance_path(path: str) → Dict[str, str][source]

Parses a instance path into its component segments.

static parse_interconnect_attachment_path(path: str) → Dict[str, str][source]

Parses a interconnect_attachment path into its component segments.

static parse_spoke_path(path: str) → Dict[str, str][source]

Parses a spoke path into its component segments.

static parse_vpn_tunnel_path(path: str) → Dict[str, str][source]

Parses a vpn_tunnel path into its component segments.

static spoke_path(project: str, location: str, spoke: str) → str[source]

Returns a fully-qualified spoke string.

property transport: google.cloud.networkconnectivity_v1alpha1.services.hub_service.transports.base.HubServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

HubServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_hub(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateHubRequest, dict]] = None, *, hub: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Hub] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Updates the parameters of a single 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_v1alpha1

def sample_update_hub():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.UpdateHubRequest(
    )

    # Make the request
    operation = client.update_hub(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.UpdateHubRequest, dict]) – The request object. Request for [HubService.UpdateHub][google.cloud.networkconnectivity.v1alpha1.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.networkconnectivity_v1alpha1.types.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.

Return type

google.api_core.operation.Operation

update_spoke(request: Optional[Union[google.cloud.networkconnectivity_v1alpha1.types.hub.UpdateSpokeRequest, dict]] = None, *, spoke: Optional[google.cloud.networkconnectivity_v1alpha1.types.hub.Spoke] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Updates the parameters of a single 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_v1alpha1

def sample_update_spoke():
    # Create a client
    client = networkconnectivity_v1alpha1.HubServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1alpha1.UpdateSpokeRequest(
    )

    # Make the request
    operation = client.update_spoke(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.networkconnectivity_v1alpha1.types.UpdateSpokeRequest, dict]) – The request object. Request for [HubService.UpdateSpoke][google.cloud.networkconnectivity.v1alpha1.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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

static vpn_tunnel_path(project: str, region: str, resource_id: str) → str[source]

Returns a fully-qualified vpn_tunnel string.

class google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsAsyncPager(method: Callable[[...], Awaitable[google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsResponse]], request: google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsRequest, response: google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_hubs requests.

This class thinly wraps an initial google.cloud.networkconnectivity_v1alpha1.types.ListHubsResponse object, and provides an __aiter__ method to iterate through its hubs field.

If there are more pages, the __aiter__ method will make additional ListHubs requests and continue to iterate through the hubs field on the corresponding responses.

All the usual google.cloud.networkconnectivity_v1alpha1.types.ListHubsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListHubsPager(method: Callable[[...], google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsResponse], request: google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsRequest, response: google.cloud.networkconnectivity_v1alpha1.types.hub.ListHubsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_hubs requests.

This class thinly wraps an initial google.cloud.networkconnectivity_v1alpha1.types.ListHubsResponse object, and provides an __iter__ method to iterate through its hubs field.

If there are more pages, the __iter__ method will make additional ListHubs requests and continue to iterate through the hubs field on the corresponding responses.

All the usual google.cloud.networkconnectivity_v1alpha1.types.ListHubsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesAsyncPager(method: Callable[[...], Awaitable[google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesResponse]], request: google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesRequest, response: google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_spokes requests.

This class thinly wraps an initial google.cloud.networkconnectivity_v1alpha1.types.ListSpokesResponse object, and provides an __aiter__ method to iterate through its spokes field.

If there are more pages, the __aiter__ method will make additional ListSpokes requests and continue to iterate through the spokes field on the corresponding responses.

All the usual google.cloud.networkconnectivity_v1alpha1.types.ListSpokesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.networkconnectivity_v1alpha1.services.hub_service.pagers.ListSpokesPager(method: Callable[[...], google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesResponse], request: google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesRequest, response: google.cloud.networkconnectivity_v1alpha1.types.hub.ListSpokesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_spokes requests.

This class thinly wraps an initial google.cloud.networkconnectivity_v1alpha1.types.ListSpokesResponse object, and provides an __iter__ method to iterate through its spokes field.

If there are more pages, the __iter__ method will make additional ListSpokes requests and continue to iterate through the spokes field on the corresponding responses.

All the usual google.cloud.networkconnectivity_v1alpha1.types.ListSpokesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters