NetworksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.networks.transports.base.NetworksTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The Networks API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
NetworksTransport | The transport used by the client instance. |
Methods
NetworksClient
NetworksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.networks.transports.base.NetworksTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the networks client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, NetworksTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
add_peering_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Adds a peering to the specified network.
Name | Description |
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 |
network |
str
Name of the network resource to add peering to. This corresponds to the |
networks_add_peering_request_resource |
google.cloud.compute_v1.types.NetworksAddPeeringRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified network.
Name | Description |
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 |
network |
str
Name of the network to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
NetworksClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
NetworksClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
NetworksClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the specified network. Gets a list of available networks by making a list() request.
Name | Description |
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 |
network |
str
Name of the network to return. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Network | Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. |
get_effective_firewalls
get_effective_firewalls(request: Optional[Union[google.cloud.compute_v1.types.compute.GetEffectiveFirewallsNetworkRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the effective firewalls on a given network.
Name | Description |
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 |
network |
str
Name of the network for this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a network in the specified project using the data included in the request.
Name | Description |
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 |
network_resource |
google.cloud.compute_v1.types.Network
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNetworksRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the list of networks available to the specified project.
Name | Description |
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 |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.services.networks.pagers.ListPager | Contains a list of networks. Iterating over this object will yield results and resolve additional pages automatically. |
list_peering_routes
list_peering_routes(request: Optional[Union[google.cloud.compute_v1.types.compute.ListPeeringRoutesNetworksRequest, dict]] = None, *, project: Optional[str] = None, network: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists the peering routes exchanged over peering connection.
Name | Description |
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 |
network |
str
Name of the network for this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.services.networks.pagers.ListPeeringRoutesPager | Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
patch_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.
Name | Description |
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 |
network |
str
Name of the network to update. This corresponds to the |
network_resource |
google.cloud.compute_v1.types.Network
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
remove_peering_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Removes a peering from the specified network.
Name | Description |
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 |
network |
str
Name of the network resource to remove peering from. This corresponds to the |
networks_remove_peering_request_resource |
google.cloud.compute_v1.types.NetworksRemovePeeringRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
switch_to_custom_mode_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Switches the network mode from auto subnet mode to custom subnet mode.
Name | Description |
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 |
network |
str
Name of the network to be updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |
update_peering_unary
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the 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.
Name | Description |
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 |
network |
str
Name of the network resource which the updated peering is belonging to. This corresponds to the |
networks_update_peering_request_resource |
google.cloud.compute_v1.types.NetworksUpdatePeeringRequest
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. |