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.

Networks

class google.cloud.compute_v1.services.networks.NetworksClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.networks.transports.base.NetworksTransport, typing.Callable[[...], google.cloud.compute_v1.services.networks.transports.base.NetworksTransport]]] = 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]

The Networks API.

Instantiates the networks 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,NetworksTransport,Callable[..., NetworksTransport]]]) – 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 NetworksTransport constructor. If set to None, a transport is chosen automatically. NOTE: “rest” transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library’s source repository.

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

add_peering(request: Optional[Union[google.cloud.compute_v1.types.compute.AddPeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_add_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksAddPeeringRequest] = 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.extended_operation.ExtendedOperation[source]

Adds a peering to the specified network.

# 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 compute_v1

def sample_add_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.AddPeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddPeeringNetworkRequest, dict]) – The request object. A request message for Networks.AddPeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource to add peering to.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_add_peering_request_resource (google.cloud.compute_v1.types.NetworksAddPeeringRequest) – The body resource for this request This corresponds to the networks_add_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

add_peering_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddPeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_add_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksAddPeeringRequest] = 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.compute_v1.types.compute.Operation[source]

Adds a peering to the specified network.

# 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 compute_v1

def sample_add_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.AddPeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.AddPeeringNetworkRequest, dict]) – The request object. A request message for Networks.AddPeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource to add peering to.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_add_peering_request_resource (google.cloud.compute_v1.types.NetworksAddPeeringRequest) – The body resource for this request This corresponds to the networks_add_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

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.

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.extended_operation.ExtendedOperation[source]

Deletes the specified network.

# 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 compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.DeleteNetworkRequest, dict]) – The request object. A request message for Networks.Delete. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to delete. This corresponds to the network 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.compute_v1.types.compute.Operation[source]

Deletes the specified network.

# 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 compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.DeleteNetworkRequest, dict]) – The request object. A request message for Networks.Delete. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to delete. This corresponds to the network 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

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

NetworksClient

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

NetworksClient

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

NetworksClient

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.compute_v1.types.compute.Network[source]

Returns the specified network.

# 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 compute_v1

def sample_get():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.GetNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.GetNetworkRequest, dict]) – The request object. A request message for Networks.Get. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to return. This corresponds to the network 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

Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

Return type

google.cloud.compute_v1.types.Network

get_effective_firewalls(request: Optional[Union[google.cloud.compute_v1.types.compute.GetEffectiveFirewallsNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.compute_v1.types.compute.NetworksGetEffectiveFirewallsResponse[source]

Returns the effective firewalls on a given network.

# 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 compute_v1

def sample_get_effective_firewalls():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.GetEffectiveFirewallsNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.GetEffectiveFirewallsNetworkRequest, dict]) – The request object. A request message for Networks.GetEffectiveFirewalls. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network for this request. This corresponds to the network 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.

Return type

google.cloud.compute_v1.types.NetworksGetEffectiveFirewallsResponse

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.

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNetworkRequest, dict]] = None, *, project: Optional[str] = None, network_resource: Optional[google.cloud.compute_v1.types.compute.Network] = 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.extended_operation.ExtendedOperation[source]

Creates a network in the specified project using the data included in the request.

# 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 compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNetworkRequest(
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.InsertNetworkRequest, dict]) – The request object. A request message for Networks.Insert. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network_resource (google.cloud.compute_v1.types.Network) – The body resource for this request This corresponds to the network_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNetworkRequest, dict]] = None, *, project: Optional[str] = None, network_resource: Optional[google.cloud.compute_v1.types.compute.Network] = 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.compute_v1.types.compute.Operation[source]

Creates a network in the specified project using the data included in the request.

# 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 compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNetworkRequest(
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.InsertNetworkRequest, dict]) – The request object. A request message for Networks.Insert. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network_resource (google.cloud.compute_v1.types.Network) – The body resource for this request This corresponds to the network_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNetworksRequest, dict]] = None, *, project: 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.compute_v1.services.networks.pagers.ListPager[source]

Retrieves the list of networks available to the specified project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.ListNetworksRequest(
        project="project_value",
    )

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

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

  • request (Union[google.cloud.compute_v1.types.ListNetworksRequest, dict]) – The request object. A request message for Networks.List. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project 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

Contains a list of networks.

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

Return type

google.cloud.compute_v1.services.networks.pagers.ListPager

list_peering_routes(request: Optional[Union[google.cloud.compute_v1.types.compute.ListPeeringRoutesNetworksRequest, dict]] = None, *, project: Optional[str] = None, network: 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.compute_v1.services.networks.pagers.ListPeeringRoutesPager[source]

Lists the peering routes exchanged over peering connection.

# 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 compute_v1

def sample_list_peering_routes():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.ListPeeringRoutesNetworksRequest(
        network="network_value",
        project="project_value",
    )

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

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

  • request (Union[google.cloud.compute_v1.types.ListPeeringRoutesNetworksRequest, dict]) – The request object. A request message for Networks.ListPeeringRoutes. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network for this request. This corresponds to the network 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

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

Return type

google.cloud.compute_v1.services.networks.pagers.ListPeeringRoutesPager

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.

patch(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, network_resource: Optional[google.cloud.compute_v1.types.compute.Network] = 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.extended_operation.ExtendedOperation[source]

Patches the specified network with the data included in the request. Only routingConfig can be modified.

# 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 compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.PatchNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.PatchNetworkRequest, dict]) – The request object. A request message for Networks.Patch. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to update. This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • network_resource (google.cloud.compute_v1.types.Network) – The body resource for this request This corresponds to the network_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, network_resource: Optional[google.cloud.compute_v1.types.compute.Network] = 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.compute_v1.types.compute.Operation[source]

Patches the specified network with the data included in the request. Only routingConfig can be modified.

# 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 compute_v1

def sample_patch():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.PatchNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.PatchNetworkRequest, dict]) – The request object. A request message for Networks.Patch. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to update. This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • network_resource (google.cloud.compute_v1.types.Network) – The body resource for this request This corresponds to the network_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

remove_peering(request: Optional[Union[google.cloud.compute_v1.types.compute.RemovePeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_remove_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksRemovePeeringRequest] = 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.extended_operation.ExtendedOperation[source]

Removes a peering from the specified network.

# 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 compute_v1

def sample_remove_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.RemovePeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemovePeeringNetworkRequest, dict]) – The request object. A request message for Networks.RemovePeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource to remove peering from.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_remove_peering_request_resource (google.cloud.compute_v1.types.NetworksRemovePeeringRequest) – The body resource for this request This corresponds to the networks_remove_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

remove_peering_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RemovePeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_remove_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksRemovePeeringRequest] = 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.compute_v1.types.compute.Operation[source]

Removes a peering from the specified network.

# 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 compute_v1

def sample_remove_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.RemovePeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.RemovePeeringNetworkRequest, dict]) – The request object. A request message for Networks.RemovePeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource to remove peering from.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_remove_peering_request_resource (google.cloud.compute_v1.types.NetworksRemovePeeringRequest) – The body resource for this request This corresponds to the networks_remove_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

switch_to_custom_mode(request: Optional[Union[google.cloud.compute_v1.types.compute.SwitchToCustomModeNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.extended_operation.ExtendedOperation[source]

Switches the network mode from auto subnet mode to custom subnet mode.

# 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 compute_v1

def sample_switch_to_custom_mode():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.SwitchToCustomModeNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SwitchToCustomModeNetworkRequest, dict]) – The request object. A request message for Networks.SwitchToCustomMode. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to be updated. This corresponds to the network 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

switch_to_custom_mode_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SwitchToCustomModeNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: 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.compute_v1.types.compute.Operation[source]

Switches the network mode from auto subnet mode to custom subnet mode.

# 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 compute_v1

def sample_switch_to_custom_mode():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.SwitchToCustomModeNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.SwitchToCustomModeNetworkRequest, dict]) – The request object. A request message for Networks.SwitchToCustomMode. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) – Name of the network to be updated. This corresponds to the network 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

property transport: google.cloud.compute_v1.services.networks.transports.base.NetworksTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

NetworksTransport

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_peering(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdatePeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_update_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksUpdatePeeringRequest] = 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.extended_operation.ExtendedOperation[source]

Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.

# 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 compute_v1

def sample_update_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.UpdatePeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.UpdatePeeringNetworkRequest, dict]) – The request object. A request message for Networks.UpdatePeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource which the updated peering is belonging to.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_update_peering_request_resource (google.cloud.compute_v1.types.NetworksUpdatePeeringRequest) – The body resource for this request This corresponds to the networks_update_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

update_peering_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdatePeeringNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, networks_update_peering_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworksUpdatePeeringRequest] = 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.compute_v1.types.compute.Operation[source]

Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.

# 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 compute_v1

def sample_update_peering():
    # Create a client
    client = compute_v1.NetworksClient()

    # Initialize request argument(s)
    request = compute_v1.UpdatePeeringNetworkRequest(
        network="network_value",
        project="project_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.compute_v1.types.UpdatePeeringNetworkRequest, dict]) – The request object. A request message for Networks.UpdatePeering. See the method description for details.

  • project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

  • network (str) –

    Name of the network resource which the updated peering is belonging to.

    This corresponds to the network field on the request instance; if request is provided, this should not be set.

  • networks_update_peering_request_resource (google.cloud.compute_v1.types.NetworksUpdatePeeringRequest) – The body resource for this request This corresponds to the networks_update_peering_request_resource 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 extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

class google.cloud.compute_v1.services.networks.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NetworkList], request: google.cloud.compute_v1.types.compute.ListNetworksRequest, response: google.cloud.compute_v1.types.compute.NetworkList, *, 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 requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NetworkList object, and provides an __iter__ method to iterate through its items field.

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

All the usual google.cloud.compute_v1.types.NetworkList 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.compute_v1.services.networks.pagers.ListPeeringRoutesPager(method: Callable[[...], google.cloud.compute_v1.types.compute.ExchangedPeeringRoutesList], request: google.cloud.compute_v1.types.compute.ListPeeringRoutesNetworksRequest, response: google.cloud.compute_v1.types.compute.ExchangedPeeringRoutesList, *, 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_peering_routes requests.

This class thinly wraps an initial google.cloud.compute_v1.types.ExchangedPeeringRoutesList object, and provides an __iter__ method to iterate through its items field.

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

All the usual google.cloud.compute_v1.types.ExchangedPeeringRoutesList 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