Class SubnetworksClient (0.5.0)

SubnetworksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.subnetworks.transports.base.SubnetworksTransport]] = 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 Subnetworks API.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`SubnetworksTransport`	The transport used by the client instance.

Methods

SubnetworksClient

SubnetworksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.subnetworks.transports.base.SubnetworksTransport]] = 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 subnetworks client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, SubnetworksTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

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

aggregated_list

aggregated_list(request: Optional[google.cloud.compute_v1.types.compute.AggregatedListSubnetworksRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an aggregated list of subnetworks.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.AggregatedListSubnetworksRequest` The request object. A request message for Subnetworks.AggregatedList. 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

Type	Description
`google.cloud.compute_v1.services.subnetworks.pagers.AggregatedListPager`	Iterating over this object will yield results and resolve additional pages automatically.

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

delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified subnetwork.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.DeleteSubnetworkRequest` The request object. A request message for Subnetworks.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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork`	`str` Name of the Subnetwork resource to delete. This corresponds to the `subnetwork` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.compute_v1.types.Operation Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

expand_ip_cidr_range

expand_ip_cidr_range(request: Optional[google.cloud.compute_v1.types.compute.ExpandIpCidrRangeSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork: Optional[str] = None, subnetworks_expand_ip_cidr_range_request_resource: Optional[google.cloud.compute_v1.types.compute.SubnetworksExpandIpCidrRangeRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Expands the IP CIDR range of the subnetwork to a specified value.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ExpandIpCidrRangeSubnetworkRequest` The request object. A request message for Subnetworks.ExpandIpCidrRange. 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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork`	`str` Name of the Subnetwork resource to update. This corresponds to the `subnetwork` field on the `request` instance; if `request` is provided, this should not be set.
`subnetworks_expand_ip_cidr_range_request_resource`	`google.cloud.compute_v1.types.SubnetworksExpandIpCidrRangeRequest` The body resource for this request This corresponds to the `subnetworks_expand_ip_cidr_range_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

Type Description

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`SubnetworksClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`SubnetworksClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`SubnetworksClient`	The constructed client.

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified subnetwork. Gets a list of available subnetworks list() request.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.GetSubnetworkRequest` The request object. A request message for Subnetworks.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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork`	`str` Name of the Subnetwork resource to return. This corresponds to the `subnetwork` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.compute_v1.types.Subnetwork`	Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.subnetworks ==)

get_iam_policy

get_iam_policy(request: Optional[google.cloud.compute_v1.types.compute.GetIamPolicySubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.GetIamPolicySubnetworkRequest` The request object. A request message for Subnetworks.GetIamPolicy. 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.
`region`	`str` The name of the region for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`resource`	`str` Name or id of the resource for this request. This corresponds to the `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

Type Description

google.cloud.compute_v1.types.Policy An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" -="" etag:="" bwwwja0yfja="-" version:="" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork_resource: Optional[google.cloud.compute_v1.types.compute.Subnetwork] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.InsertSubnetworkRequest` The request object. A request message for Subnetworks.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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork_resource`	`google.cloud.compute_v1.types.Subnetwork` The body resource for this request This corresponds to the `subnetwork_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

Type Description

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListSubnetworksRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves a list of subnetworks available to the specified project.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ListSubnetworksRequest` The request object. A request message for Subnetworks.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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.compute_v1.services.subnetworks.pagers.ListPager`	Contains a list of Subnetwork resources. Iterating over this object will yield results and resolve additional pages automatically.

list_usable

list_usable(request: Optional[google.cloud.compute_v1.types.compute.ListUsableSubnetworksRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an aggregated list of all usable subnetworks in the project.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.ListUsableSubnetworksRequest` The request object. A request message for Subnetworks.ListUsable. 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

Type	Description
`google.cloud.compute_v1.services.subnetworks.pagers.ListUsablePager`	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

patch(request: Optional[google.cloud.compute_v1.types.compute.PatchSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork: Optional[str] = None, subnetwork_resource: Optional[google.cloud.compute_v1.types.compute.Subnetwork] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.PatchSubnetworkRequest` The request object. A request message for Subnetworks.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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork`	`str` Name of the Subnetwork resource to patch. This corresponds to the `subnetwork` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork_resource`	`google.cloud.compute_v1.types.Subnetwork` The body resource for this request This corresponds to the `subnetwork_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

Type Description

set_iam_policy

set_iam_policy(request: Optional[google.cloud.compute_v1.types.compute.SetIamPolicySubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_policy_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetPolicyRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.SetIamPolicySubnetworkRequest` The request object. A request message for Subnetworks.SetIamPolicy. 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.
`region`	`str` The name of the region for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`resource`	`str` Name or id of the resource for this request. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`region_set_policy_request_resource`	`google.cloud.compute_v1.types.RegionSetPolicyRequest` The body resource for this request This corresponds to the `region_set_policy_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

Type Description

set_private_ip_google_access

set_private_ip_google_access(request: Optional[google.cloud.compute_v1.types.compute.SetPrivateIpGoogleAccessSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, subnetwork: Optional[str] = None, subnetworks_set_private_ip_google_access_request_resource: Optional[google.cloud.compute_v1.types.compute.SubnetworksSetPrivateIpGoogleAccessRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.SetPrivateIpGoogleAccessSubnetworkRequest` The request object. A request message for Subnetworks.SetPrivateIpGoogleAccess. 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.
`region`	`str` Name of the region scoping this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`subnetwork`	`str` Name of the Subnetwork resource. This corresponds to the `subnetwork` field on the `request` instance; if `request` is provided, this should not be set.
`subnetworks_set_private_ip_google_access_request_resource`	`google.cloud.compute_v1.types.SubnetworksSetPrivateIpGoogleAccessRequest` The body resource for this request This corresponds to the `subnetworks_set_private_ip_google_access_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

Type Description

test_iam_permissions

test_iam_permissions(request: Optional[google.cloud.compute_v1.types.compute.TestIamPermissionsSubnetworkRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns permissions that a caller has on the specified resource.

Parameters

Name	Description
`request`	`google.cloud.compute_v1.types.TestIamPermissionsSubnetworkRequest` The request object. A request message for Subnetworks.TestIamPermissions. 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.
`region`	`str` The name of the region for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`resource`	`str` Name or id of the resource for this request. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`test_permissions_request_resource`	`google.cloud.compute_v1.types.TestPermissionsRequest` The body resource for this request This corresponds to the `test_permissions_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.