Service for the vpnTunnels resource.
https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
VpnTunnelsClient(VpnTunnelsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnTunnelsClient const &
|
VpnTunnelsClient(VpnTunnelsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnTunnelsClient &&
|
VpnTunnelsClient(std::shared_ptr< VpnTunnelsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< VpnTunnelsConnection >
|
opts |
Options
|
Operators
operator=(VpnTunnelsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnTunnelsClient const &
|
Returns | |
---|---|
Type | Description |
VpnTunnelsClient & |
operator=(VpnTunnelsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnTunnelsClient &&
|
Returns | |
---|---|
Type | Description |
VpnTunnelsClient & |
Functions
AggregatedListVpnTunnels(std::string const &, Options)
Retrieves an aggregated list of VPN tunnels.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::VpnTunnelsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListVpnTunnels(google::cloud::cpp::compute::vpn_tunnels::v1::AggregatedListVpnTunnelsRequest, Options)
Retrieves an aggregated list of VPN tunnels.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::AggregatedListVpnTunnelsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::VpnTunnelsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteVpnTunnel(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified VpnTunnel resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_tunnel |
std::string const &
Name of the VpnTunnel resource to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteVpnTunnel(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified VpnTunnel resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
vpn_tunnel |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteVpnTunnel(google::cloud::cpp::compute::vpn_tunnels::v1::DeleteVpnTunnelRequest const &, Options)
Deletes the specified VpnTunnel resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::DeleteVpnTunnelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteVpnTunnel(NoAwaitTag, google::cloud::cpp::compute::vpn_tunnels::v1::DeleteVpnTunnelRequest const &, Options)
Deletes the specified VpnTunnel resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::vpn_tunnels::v1::DeleteVpnTunnelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteVpnTunnel(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified VpnTunnel resource.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetVpnTunnel(std::string const &, std::string const &, std::string const &, Options)
Returns the specified VpnTunnel resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_tunnel |
std::string const &
Name of the VpnTunnel resource to return. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::VpnTunnel > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnTunnel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVpnTunnel(google::cloud::cpp::compute::vpn_tunnels::v1::GetVpnTunnelRequest const &, Options)
Returns the specified VpnTunnel resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::GetVpnTunnelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::VpnTunnel > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnTunnel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertVpnTunnel(std::string const &, std::string const &, google::cloud::cpp::compute::v1::VpnTunnel const &, Options)
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_tunnel_resource |
google::cloud::cpp::compute::v1::VpnTunnel const &
The VpnTunnel for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertVpnTunnel(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::VpnTunnel const &, Options)
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
vpn_tunnel_resource |
google::cloud::cpp::compute::v1::VpnTunnel const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertVpnTunnel(google::cloud::cpp::compute::vpn_tunnels::v1::InsertVpnTunnelRequest const &, Options)
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::InsertVpnTunnelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertVpnTunnel(NoAwaitTag, google::cloud::cpp::compute::vpn_tunnels::v1::InsertVpnTunnelRequest const &, Options)
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::vpn_tunnels::v1::InsertVpnTunnelRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertVpnTunnel(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListVpnTunnels(std::string const &, std::string const &, Options)
Retrieves a list of VpnTunnel resources contained in the specified project and region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::VpnTunnel > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVpnTunnels(google::cloud::cpp::compute::vpn_tunnels::v1::ListVpnTunnelsRequest, Options)
Retrieves a list of VpnTunnel resources contained in the specified project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::ListVpnTunnelsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::VpnTunnel > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SetLabels(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on a VpnTunnel.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels/setLabels
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
region_set_labels_request_resource |
google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
The RegionSetLabelsRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
SetLabels(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on a VpnTunnel.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
resource |
std::string const &
|
region_set_labels_request_resource |
google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::vpn_tunnels::v1::SetLabelsRequest const &, Options)
Sets the labels on a VpnTunnel.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels/setLabels
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_tunnels::v1::SetLabelsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
SetLabels(NoAwaitTag, google::cloud::cpp::compute::vpn_tunnels::v1::SetLabelsRequest const &, Options)
Sets the labels on a VpnTunnel.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::vpn_tunnels::v1::SetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the labels on a VpnTunnel.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |