Service for the vpnGateways resource.
https://cloud.google.com/compute/docs/reference/rest/v1/vpnGateways
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
VpnGatewaysClient(VpnGatewaysClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnGatewaysClient const &
|
VpnGatewaysClient(VpnGatewaysClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnGatewaysClient &&
|
VpnGatewaysClient(std::shared_ptr< VpnGatewaysConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< VpnGatewaysConnection >
|
opts |
Options
|
Operators
operator=(VpnGatewaysClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnGatewaysClient const &
|
Returns | |
---|---|
Type | Description |
VpnGatewaysClient & |
operator=(VpnGatewaysClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VpnGatewaysClient &&
|
Returns | |
---|---|
Type | Description |
VpnGatewaysClient & |
Functions
AggregatedListVpnGateways(std::string const &, Options)
Retrieves an aggregated list of VPN gateways.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/vpnGateways/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::VpnGatewaysScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListVpnGateways(google::cloud::cpp::compute::vpn_gateways::v1::AggregatedListVpnGatewaysRequest, Options)
Retrieves an aggregated list of VPN gateways.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/vpnGateways/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::AggregatedListVpnGatewaysRequest
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::VpnGatewaysScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteVpnGateway(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_gateway |
std::string const &
Name of the VPN gateway 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 |
DeleteVpnGateway(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified VPN gateway.
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_gateway |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteVpnGateway(google::cloud::cpp::compute::vpn_gateways::v1::DeleteVpnGatewayRequest const &, Options)
Deletes the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::DeleteVpnGatewayRequest 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 |
DeleteVpnGateway(NoAwaitTag, google::cloud::cpp::compute::vpn_gateways::v1::DeleteVpnGatewayRequest const &, Options)
Deletes the specified VPN gateway.
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_gateways::v1::DeleteVpnGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteVpnGateway(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified VPN gateway.
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 > > |
GetVpnGateway(std::string const &, std::string const &, std::string const &, Options)
Returns the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_gateway |
std::string const &
Name of the VPN gateway 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::VpnGateway > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVpnGateway(google::cloud::cpp::compute::vpn_gateways::v1::GetVpnGatewayRequest const &, Options)
Returns the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::GetVpnGatewayRequest 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::VpnGateway > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStatus(std::string const &, std::string const &, std::string const &, Options)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
vpn_gateway |
std::string const &
Name of the VPN gateway 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::VpnGatewaysGetStatusResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnGatewaysGetStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStatus(google::cloud::cpp::compute::vpn_gateways::v1::GetStatusRequest const &, Options)
Returns the status for the specified VPN gateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::GetStatusRequest 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::VpnGatewaysGetStatusResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VpnGatewaysGetStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertVpnGateway(std::string const &, std::string const &, google::cloud::cpp::compute::v1::VpnGateway const &, Options)
Creates a VPN gateway 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_gateway_resource |
google::cloud::cpp::compute::v1::VpnGateway const &
The VpnGateway 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 |
InsertVpnGateway(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::VpnGateway const &, Options)
Creates a VPN gateway 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_gateway_resource |
google::cloud::cpp::compute::v1::VpnGateway const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertVpnGateway(google::cloud::cpp::compute::vpn_gateways::v1::InsertVpnGatewayRequest const &, Options)
Creates a VPN gateway in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::InsertVpnGatewayRequest 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 |
InsertVpnGateway(NoAwaitTag, google::cloud::cpp::compute::vpn_gateways::v1::InsertVpnGatewayRequest const &, Options)
Creates a VPN gateway 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_gateways::v1::InsertVpnGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertVpnGateway(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a VPN gateway 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 > > |
ListVpnGateways(std::string const &, std::string const &, Options)
Retrieves a list of VPN gateways available to 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::VpnGateway > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVpnGateways(google::cloud::cpp::compute::vpn_gateways::v1::ListVpnGatewaysRequest, Options)
Retrieves a list of VPN gateways available to the specified project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::ListVpnGatewaysRequest
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::VpnGateway > |
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 VpnGateway.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/vpnGateways/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 VpnGateway.
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_gateways::v1::SetLabelsRequest const &, Options)
Sets the labels on a VpnGateway.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/vpnGateways/setLabels
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::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_gateways::v1::SetLabelsRequest const &, Options)
Sets the labels on a VpnGateway.
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_gateways::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 VpnGateway.
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 > > |
TestIamPermissions(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
test_permissions_request_resource |
google::cloud::cpp::compute::v1::TestPermissionsRequest const &
The TestPermissionsRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::cloud::cpp::compute::vpn_gateways::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::vpn_gateways::v1::TestIamPermissionsRequest 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::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |