Class VpnTunnelsClient (1.7.0)

VpnTunnelsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.vpn_tunnels.transports.base.VpnTunnelsTransport]] = None, client_options: Optional[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>)

The VpnTunnels API.

Properties

transport

Returns the transport used by the client instance.

Returns

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

Methods

VpnTunnelsClient

VpnTunnelsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.vpn_tunnels.transports.base.VpnTunnelsTransport]] = None, client_options: Optional[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>)

Instantiates the vpn tunnels 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, VpnTunnelsTransport]` The transport to use. 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. 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.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

aggregated_list

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListVpnTunnelsRequest, 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an aggregated list of VPN tunnels.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.AggregatedListVpnTunnelsRequest, dict]` The request object. A request message for VpnTunnels.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.vpn_tunnels.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[Union[google.cloud.compute_v1.types.compute.DeleteVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, vpn_tunnel: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified VpnTunnel resource.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.DeleteVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.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 for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`vpn_tunnel`	`str` Name of the VpnTunnel resource to delete. This corresponds to the `vpn_tunnel` 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.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.

delete_unary

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, vpn_tunnel: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified VpnTunnel resource.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.DeleteVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.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 for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`vpn_tunnel`	`str` Name of the VpnTunnel resource to delete. This corresponds to the `vpn_tunnel` 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.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.

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
`VpnTunnelsClient`	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
`VpnTunnelsClient`	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
`VpnTunnelsClient`	The constructed client.

get

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

Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.GetVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.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 for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`vpn_tunnel`	`str` Name of the VpnTunnel resource to return. This corresponds to the `vpn_tunnel` 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.VpnTunnel`	Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

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.

Parameter

Name	Description
`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.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns

Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

insert

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, vpn_tunnel_resource: Optional[google.cloud.compute_v1.types.compute.VpnTunnel] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.InsertVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.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 for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`vpn_tunnel_resource`	`google.cloud.compute_v1.types.VpnTunnel` The body resource for this request This corresponds to the `vpn_tunnel_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.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.

insert_unary

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, vpn_tunnel_resource: Optional[google.cloud.compute_v1.types.compute.VpnTunnel] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.InsertVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.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 for this request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
`vpn_tunnel_resource`	`google.cloud.compute_v1.types.VpnTunnel` The body resource for this request This corresponds to the `vpn_tunnel_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.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.

list

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

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.ListVpnTunnelsRequest, dict]` The request object. A request message for VpnTunnels.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 for 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.vpn_tunnels.pagers.ListPager`	Contains a list of VpnTunnel resources. 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.

set_labels

set_labels(request: Optional[Union[google.cloud.compute_v1.types.compute.SetLabelsVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_labels_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetLabelsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.SetLabelsVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.SetLabels. 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 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_labels_request_resource`	`google.cloud.compute_v1.types.RegionSetLabelsRequest` The body resource for this request This corresponds to the `region_set_labels_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
`google.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.

set_labels_unary

set_labels_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetLabelsVpnTunnelRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_labels_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetLabelsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.

Parameters

Name	Description
`request`	`Union[google.cloud.compute_v1.types.SetLabelsVpnTunnelRequest, dict]` The request object. A request message for VpnTunnels.SetLabels. 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 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_labels_request_resource`	`google.cloud.compute_v1.types.RegionSetLabelsRequest` The body resource for this request This corresponds to the `region_set_labels_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
`google.api_core.extended_operation.ExtendedOperation`	An object representing a extended long-running operation.