Class TargetPoolsClient (2.23.0-rc)

Service for the targetPools resource.

https://cloud.google.com/compute/docs/reference/rest/v1/targetPools

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

TargetPoolsClient(TargetPoolsClient const &)

Copy and move support

Parameter
NameDescription
TargetPoolsClient const &

TargetPoolsClient(TargetPoolsClient &&)

Copy and move support

Parameter
NameDescription
TargetPoolsClient &&

TargetPoolsClient(std::shared_ptr< TargetPoolsConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< TargetPoolsConnection >
opts Options

Operators

operator=(TargetPoolsClient const &)

Copy and move support

Parameter
NameDescription
TargetPoolsClient const &
Returns
TypeDescription
TargetPoolsClient &

operator=(TargetPoolsClient &&)

Copy and move support

Parameter
NameDescription
TargetPoolsClient &&
Returns
TypeDescription
TargetPoolsClient &

Functions

AddHealthCheck(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetPoolsAddHealthCheckRequest const &, Options)

Adds health check URLs to a target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the target pool to add a health check to.

target_pools_add_health_check_request_resource google::cloud::cpp::compute::v1::TargetPoolsAddHealthCheckRequest const &

The TargetPoolsAddHealthCheckRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddHealthCheck(google::cloud::cpp::compute::target_pools::v1::AddHealthCheckRequest const &, Options)

Adds health check URLs to a target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::AddHealthCheckRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.AddHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddInstance(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetPoolsAddInstanceRequest const &, Options)

Adds an instance to a target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to add instances to.

target_pools_add_instance_request_resource google::cloud::cpp::compute::v1::TargetPoolsAddInstanceRequest const &

The TargetPoolsAddInstanceRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddInstance(google::cloud::cpp::compute::target_pools::v1::AddInstanceRequest const &, Options)

Adds an instance to a target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::AddInstanceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.AddInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AggregatedListTargetPools(std::string const &, Options)

Retrieves an aggregated list of target pools.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/targetPools/aggregatedList

Parameters
NameDescription
project std::string const &

Project ID for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::TargetPoolsScopedList > >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.TargetPoolsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListTargetPools(google::cloud::cpp::compute::target_pools::v1::AggregatedListTargetPoolsRequest, Options)

Retrieves an aggregated list of target pools.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/targetPools/aggregatedList

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::AggregatedListTargetPoolsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.AggregatedListTargetPoolsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::TargetPoolsScopedList > >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.TargetPoolsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteTargetPool(std::string const &, std::string const &, std::string const &, Options)

Deletes the specified target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTargetPool(google::cloud::cpp::compute::target_pools::v1::DeleteTargetPoolRequest const &, Options)

Deletes the specified target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::DeleteTargetPoolRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.DeleteTargetPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetTargetPool(std::string const &, std::string const &, std::string const &, Options)

Returns the specified target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to return.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::TargetPool >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTargetPool(google::cloud::cpp::compute::target_pools::v1::GetTargetPoolRequest const &, Options)

Returns the specified target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::GetTargetPoolRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.GetTargetPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::TargetPool >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetPool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetHealth(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceReference const &, Options)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to which the queried instance belongs.

instance_reference_resource google::cloud::cpp::compute::v1::InstanceReference const &

The InstanceReference for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::TargetPoolInstanceHealth >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetPoolInstanceHealth) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetHealth(google::cloud::cpp::compute::target_pools::v1::GetHealthRequest const &, Options)

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::GetHealthRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.GetHealthRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::TargetPoolInstanceHealth >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetPoolInstanceHealth) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertTargetPool(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetPool const &, Options)

Creates a target pool in the specified project and region using the data included in the request.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool_resource google::cloud::cpp::compute::v1::TargetPool const &

The TargetPool for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertTargetPool(google::cloud::cpp::compute::target_pools::v1::InsertTargetPoolRequest const &, Options)

Creates a target pool in the specified project and region using the data included in the request.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::InsertTargetPoolRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.InsertTargetPoolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListTargetPools(std::string const &, std::string const &, Options)

Retrieves a list of target pools available to the specified project and region.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::TargetPool >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.TargetPool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTargetPools(google::cloud::cpp::compute::target_pools::v1::ListTargetPoolsRequest, Options)

Retrieves a list of target pools available to the specified project and region.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::ListTargetPoolsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.ListTargetPoolsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::TargetPool >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.TargetPool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RemoveHealthCheck(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetPoolsRemoveHealthCheckRequest const &, Options)

Removes health check URL from a target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region for this request.

target_pool std::string const &

Name of the target pool to remove health checks from.

target_pools_remove_health_check_request_resource google::cloud::cpp::compute::v1::TargetPoolsRemoveHealthCheckRequest const &

The TargetPoolsRemoveHealthCheckRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveHealthCheck(google::cloud::cpp::compute::target_pools::v1::RemoveHealthCheckRequest const &, Options)

Removes health check URL from a target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::RemoveHealthCheckRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.RemoveHealthCheckRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveInstance(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetPoolsRemoveInstanceRequest const &, Options)

Removes instance URL from a target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to remove instances from.

target_pools_remove_instance_request_resource google::cloud::cpp::compute::v1::TargetPoolsRemoveInstanceRequest const &

The TargetPoolsRemoveInstanceRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveInstance(google::cloud::cpp::compute::target_pools::v1::RemoveInstanceRequest const &, Options)

Removes instance URL from a target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::RemoveInstanceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.RemoveInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetBackup(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetReference const &, Options)

Changes a backup target pool's configurations.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to set a backup pool for.

target_reference_resource google::cloud::cpp::compute::v1::TargetReference const &

The TargetReference for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetBackup(google::cloud::cpp::compute::target_pools::v1::SetBackupRequest const &, Options)

Changes a backup target pool's configurations.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::SetBackupRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.SetBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetSecurityPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::SecurityPolicyReference const &, Options)

Sets the Google Cloud Armor security policy for the specified target pool.

Parameters
NameDescription
project std::string const &

Project ID for this request.

region std::string const &

Name of the region scoping this request.

target_pool std::string const &

Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.

security_policy_reference_resource google::cloud::cpp::compute::v1::SecurityPolicyReference const &

The SecurityPolicyReference for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetSecurityPolicy(google::cloud::cpp::compute::target_pools::v1::SetSecurityPolicyRequest const &, Options)

Sets the Google Cloud Armor security policy for the specified target pool.

Parameters
NameDescription
request google::cloud::cpp::compute::target_pools::v1::SetSecurityPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.target_pools.v1.SetSecurityPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.