Service for the externalVpnGateways resource.
https://cloud.google.com/compute/docs/reference/rest/v1/externalVpnGateways
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
ExternalVpnGatewaysClient(ExternalVpnGatewaysClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ExternalVpnGatewaysClient const &
|
ExternalVpnGatewaysClient(ExternalVpnGatewaysClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ExternalVpnGatewaysClient &&
|
ExternalVpnGatewaysClient(std::shared_ptr< ExternalVpnGatewaysConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ExternalVpnGatewaysConnection >
|
opts |
Options
|
Operators
operator=(ExternalVpnGatewaysClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ExternalVpnGatewaysClient const &
|
Returns | |
---|---|
Type | Description |
ExternalVpnGatewaysClient & |
operator=(ExternalVpnGatewaysClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ExternalVpnGatewaysClient &&
|
Returns | |
---|---|
Type | Description |
ExternalVpnGatewaysClient & |
Functions
DeleteExternalVpnGateway(std::string const &, std::string const &, Options)
Deletes the specified externalVpnGateway.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
external_vpn_gateway |
std::string const &
Name of the externalVpnGateways 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 |
DeleteExternalVpnGateway(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified externalVpnGateway.
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 &
|
external_vpn_gateway |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteExternalVpnGateway(google::cloud::cpp::compute::external_vpn_gateways::v1::DeleteExternalVpnGatewayRequest const &, Options)
Deletes the specified externalVpnGateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_vpn_gateways::v1::DeleteExternalVpnGatewayRequest 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 |
DeleteExternalVpnGateway(NoAwaitTag, google::cloud::cpp::compute::external_vpn_gateways::v1::DeleteExternalVpnGatewayRequest const &, Options)
Deletes the specified externalVpnGateway.
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::external_vpn_gateways::v1::DeleteExternalVpnGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteExternalVpnGateway(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified externalVpnGateway.
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 > > |
GetExternalVpnGateway(std::string const &, std::string const &, Options)
Returns the specified externalVpnGateway.
Get a list of available externalVpnGateways by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/externalVpnGateways/get
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
external_vpn_gateway |
std::string const &
Name of the externalVpnGateway 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::ExternalVpnGateway > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ExternalVpnGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetExternalVpnGateway(google::cloud::cpp::compute::external_vpn_gateways::v1::GetExternalVpnGatewayRequest const &, Options)
Returns the specified externalVpnGateway.
Get a list of available externalVpnGateways by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/externalVpnGateways/get
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_vpn_gateways::v1::GetExternalVpnGatewayRequest 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::ExternalVpnGateway > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ExternalVpnGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertExternalVpnGateway(std::string const &, google::cloud::cpp::compute::v1::ExternalVpnGateway const &, Options)
Creates a ExternalVpnGateway in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
external_vpn_gateway_resource |
google::cloud::cpp::compute::v1::ExternalVpnGateway const &
The ExternalVpnGateway 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 |
InsertExternalVpnGateway(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::ExternalVpnGateway const &, Options)
Creates a ExternalVpnGateway in the specified project 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 &
|
external_vpn_gateway_resource |
google::cloud::cpp::compute::v1::ExternalVpnGateway const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertExternalVpnGateway(google::cloud::cpp::compute::external_vpn_gateways::v1::InsertExternalVpnGatewayRequest const &, Options)
Creates a ExternalVpnGateway in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_vpn_gateways::v1::InsertExternalVpnGatewayRequest 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 |
InsertExternalVpnGateway(NoAwaitTag, google::cloud::cpp::compute::external_vpn_gateways::v1::InsertExternalVpnGatewayRequest const &, Options)
Creates a ExternalVpnGateway in the specified project 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::external_vpn_gateways::v1::InsertExternalVpnGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertExternalVpnGateway(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a ExternalVpnGateway in the specified project 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 > > |
ListExternalVpnGateways(std::string const &, Options)
Retrieves the list of ExternalVpnGateway available to the specified project.
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< google::cloud::cpp::compute::v1::ExternalVpnGateway > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListExternalVpnGateways(google::cloud::cpp::compute::external_vpn_gateways::v1::ListExternalVpnGatewaysRequest, Options)
Retrieves the list of ExternalVpnGateway available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_vpn_gateways::v1::ListExternalVpnGatewaysRequest
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::ExternalVpnGateway > |
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 &, google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &, Options)
Sets the labels on an ExternalVpnGateway.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/externalVpnGateways/setLabels
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
global_set_labels_request_resource |
google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &
The GlobalSetLabelsRequest 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 &, google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &, Options)
Sets the labels on an ExternalVpnGateway.
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 &
|
resource |
std::string const &
|
global_set_labels_request_resource |
google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::external_vpn_gateways::v1::SetLabelsRequest const &, Options)
Sets the labels on an ExternalVpnGateway.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/externalVpnGateways/setLabels
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_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::external_vpn_gateways::v1::SetLabelsRequest const &, Options)
Sets the labels on an ExternalVpnGateway.
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::external_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 an ExternalVpnGateway.
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 &, 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. |
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::external_vpn_gateways::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::external_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 |