Class BackendServicesClient (2.16.0)

Service for the backendServices resource.

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

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

BackendServicesClient(BackendServicesClient const &)

Copy and move support

Parameter
Name Description
BackendServicesClient const &

BackendServicesClient(BackendServicesClient &&)

Copy and move support

Parameter
Name Description
BackendServicesClient &&

BackendServicesClient(std::shared_ptr< BackendServicesConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< BackendServicesConnection >
opts Options

Operators

operator=(BackendServicesClient const &)

Copy and move support

Parameter
Name Description
BackendServicesClient const &
Returns
Type Description
BackendServicesClient &

operator=(BackendServicesClient &&)

Copy and move support

Parameter
Name Description
BackendServicesClient &&
Returns
Type Description
BackendServicesClient &

Functions

AddSignedUrlKey(std::string const &, std::string const &, google::cloud::cpp::compute::v1::SignedUrlKey const &, Options)

Adds a key for validating requests with signed URLs for this backend service.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

signed_url_key_resource google::cloud::cpp::compute::v1::SignedUrlKey const &

The SignedUrlKey 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 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.

AddSignedUrlKey(google::cloud::cpp::compute::backend_services::v1::AddSignedUrlKeyRequest const &, Options)

Adds a key for validating requests with signed URLs for this backend service.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::AddSignedUrlKeyRequest 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.backend_services.v1.AddSignedUrlKeyRequest. 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
Type Description
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.

AggregatedListBackendServices(std::string const &, Options)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Parameters
Name Description
project std::string const &

Name of the project scoping 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::BackendServicesScopedList > >

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.BackendServicesScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListBackendServices(google::cloud::cpp::compute::backend_services::v1::AggregatedListBackendServicesRequest, Options)

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::AggregatedListBackendServicesRequest

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.backend_services.v1.AggregatedListBackendServicesRequest. 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
Type Description
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::BackendServicesScopedList > >

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.BackendServicesScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Deletes the specified BackendService resource.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService 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 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.

DeleteBackendService(google::cloud::cpp::compute::backend_services::v1::DeleteBackendServiceRequest const &, Options)

Deletes the specified BackendService resource.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::DeleteBackendServiceRequest 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.backend_services.v1.DeleteBackendServiceRequest. 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
Type Description
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.

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

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.

key_name std::string const &

The name of the Signed URL Key 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 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.

DeleteSignedUrlKey(google::cloud::cpp::compute::backend_services::v1::DeleteSignedUrlKeyRequest const &, Options)

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::DeleteSignedUrlKeyRequest 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.backend_services.v1.DeleteSignedUrlKeyRequest. 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
Type Description
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.

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

Returns the specified BackendService resource.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService 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::BackendService >

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

GetBackendService(google::cloud::cpp::compute::backend_services::v1::GetBackendServiceRequest const &, Options)

Returns the specified BackendService resource.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::GetBackendServiceRequest 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.backend_services.v1.GetBackendServiceRequest. 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
Type Description
StatusOr< google::cloud::cpp::compute::v1::BackendService >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.BackendService) 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 &, google::cloud::cpp::compute::v1::ResourceGroupReference const &, Options)

Gets the most recent health check results for this BackendService.

Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" } https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/getHealth

Parameters
Name Description
project std::string const &
backend_service std::string const &

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

resource_group_reference_resource google::cloud::cpp::compute::v1::ResourceGroupReference const &

The ResourceGroupReference 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::BackendServiceGroupHealth >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.BackendServiceGroupHealth) 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::backend_services::v1::GetHealthRequest const &, Options)

Gets the most recent health check results for this BackendService.

Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" } https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/getHealth

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::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.backend_services.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
Type Description
StatusOr< google::cloud::cpp::compute::v1::BackendServiceGroupHealth >

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

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

Gets the access control policy for a 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.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Policy >

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

GetIamPolicy(google::cloud::cpp::compute::backend_services::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::GetIamPolicyRequest 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.backend_services.v1.GetIamPolicyRequest. 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
Type Description
StatusOr< google::cloud::cpp::compute::v1::Policy >

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

InsertBackendService(std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)

Creates a BackendService resource in the specified project using the data included in the request.

For more information, see Backend services overview . https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/insert

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service_resource google::cloud::cpp::compute::v1::BackendService const &

The BackendService 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 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.

InsertBackendService(google::cloud::cpp::compute::backend_services::v1::InsertBackendServiceRequest const &, Options)

Creates a BackendService resource in the specified project using the data included in the request.

For more information, see Backend services overview . https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/insert

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::InsertBackendServiceRequest 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.backend_services.v1.InsertBackendServiceRequest. 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
Type Description
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.

ListBackendServices(std::string const &, Options)

Retrieves the list of BackendService resources 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::BackendService >

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.BackendService, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListBackendServices(google::cloud::cpp::compute::backend_services::v1::ListBackendServicesRequest, Options)

Retrieves the list of BackendService resources available to the specified project.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::ListBackendServicesRequest

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.backend_services.v1.ListBackendServicesRequest. 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
Type Description
StreamRange< google::cloud::cpp::compute::v1::BackendService >

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.BackendService, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

PatchBackendService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)

Patches the specified BackendService resource with the data included in the request.

For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/patch

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService resource to patch.

backend_service_resource google::cloud::cpp::compute::v1::BackendService const &

The BackendService 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 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.

PatchBackendService(google::cloud::cpp::compute::backend_services::v1::PatchBackendServiceRequest const &, Options)

Patches the specified BackendService resource with the data included in the request.

For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/patch

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::PatchBackendServiceRequest 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.backend_services.v1.PatchBackendServiceRequest. 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
Type Description
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.

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

Sets the edge security policy for the specified backend service.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService resource to which the edge 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
Type Description
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.

SetEdgeSecurityPolicy(google::cloud::cpp::compute::backend_services::v1::SetEdgeSecurityPolicyRequest const &, Options)

Sets the edge security policy for the specified backend service.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::SetEdgeSecurityPolicyRequest 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.backend_services.v1.SetEdgeSecurityPolicyRequest. 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
Type Description
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.

SetIamPolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const &, Options)

Sets the access control policy 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.

global_set_policy_request_resource google::cloud::cpp::compute::v1::GlobalSetPolicyRequest const &

The GlobalSetPolicyRequest 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::Policy >

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

SetIamPolicy(google::cloud::cpp::compute::backend_services::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::SetIamPolicyRequest 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.backend_services.v1.SetIamPolicyRequest. 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
Type Description
StatusOr< google::cloud::cpp::compute::v1::Policy >

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

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

Sets the Google Cloud Armor security policy for the specified backend service.

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService 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
Type Description
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::backend_services::v1::SetSecurityPolicyRequest const &, Options)

Sets the Google Cloud Armor security policy for the specified backend service.

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::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.backend_services.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
Type Description
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.

UpdateBackendService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)

Updates the specified BackendService resource with the data included in the request.

For more information, see Backend services overview. https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/update

Parameters
Name Description
project std::string const &

Project ID for this request.

backend_service std::string const &

Name of the BackendService resource to update.

backend_service_resource google::cloud::cpp::compute::v1::BackendService const &

The BackendService 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 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.

UpdateBackendService(google::cloud::cpp::compute::backend_services::v1::UpdateBackendServiceRequest const &, Options)

Updates the specified BackendService resource with the data included in the request.

For more information, see Backend services overview. https://cloud.google.com/compute/docs/reference/rest/v1/backendServices/update

Parameters
Name Description
request google::cloud::cpp::compute::backend_services::v1::UpdateBackendServiceRequest 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.backend_services.v1.UpdateBackendServiceRequest. 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
Type Description
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.