Service for the regionBackendServices resource.
https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices
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
RegionBackendServicesClient(RegionBackendServicesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionBackendServicesClient const &
|
RegionBackendServicesClient(RegionBackendServicesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionBackendServicesClient &&
|
RegionBackendServicesClient(std::shared_ptr< RegionBackendServicesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< RegionBackendServicesConnection >
|
opts |
Options
|
Operators
operator=(RegionBackendServicesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionBackendServicesClient const &
|
Returns | |
---|---|
Type | Description |
RegionBackendServicesClient & |
operator=(RegionBackendServicesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionBackendServicesClient &&
|
Returns | |
---|---|
Type | Description |
RegionBackendServicesClient & |
Functions
DeleteBackendService(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified regional BackendService resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
DeleteBackendService(google::cloud::cpp::compute::region_backend_services::v1::DeleteBackendServiceRequest const &, Options)
Deletes the specified regional BackendService resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::DeleteBackendServiceRequest 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 |
GetBackendService(std::string const &, std::string const &, std::string const &, Options)
Returns the specified regional BackendService resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
GetBackendService(google::cloud::cpp::compute::region_backend_services::v1::GetBackendServiceRequest const &, Options)
Returns the specified regional BackendService resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::GetBackendServiceRequest 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::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 |
GetHealth(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ResourceGroupReference const &, Options)
Gets the most recent health check results for this regional BackendService.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
|
region |
std::string const &
Name of the region scoping this request. |
backend_service |
std::string const &
Name of the BackendService resource for which to get health. |
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 |
GetHealth(google::cloud::cpp::compute::region_backend_services::v1::GetHealthRequest const &, Options)
Gets the most recent health check results for this regional BackendService.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::GetHealthRequest 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::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 |
GetIamPolicy(std::string const &, std::string const &, std::string const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/getIamPolicy
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. |
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 |
GetIamPolicy(google::cloud::cpp::compute::region_backend_services::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::GetIamPolicyRequest 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::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 |
InsertBackendService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)
Creates a regional 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/regionBackendServices/insert
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
InsertBackendService(google::cloud::cpp::compute::region_backend_services::v1::InsertBackendServiceRequest const &, Options)
Creates a regional 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/regionBackendServices/insert
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::InsertBackendServiceRequest 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 |
ListRegionBackendServices(std::string const &, std::string const &, Options)
Retrieves the list of regional BackendService resources available to the specified project in the given region.
Parameters | |
---|---|
Name | Description |
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 | |
---|---|
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 |
ListRegionBackendServices(google::cloud::cpp::compute::region_backend_services::v1::ListRegionBackendServicesRequest, Options)
Retrieves the list of regional BackendService resources available to the specified project in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::ListRegionBackendServicesRequest
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::BackendService > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUsable(std::string const &, std::string const &, Options)
Retrieves an aggregated list of all usable backend services in the specified project in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. |
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 |
ListUsable(google::cloud::cpp::compute::region_backend_services::v1::ListUsableRequest, Options)
Retrieves an aggregated list of all usable backend services in the specified project in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::ListUsableRequest
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::BackendService > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchBackendService(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)
Updates the specified regional BackendService resource with the data included in the request.
For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
PatchBackendService(google::cloud::cpp::compute::region_backend_services::v1::PatchBackendServiceRequest const &, Options)
Updates the specified regional BackendService resource with the data included in the request.
For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::PatchBackendServiceRequest 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 |
SetIamPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/setIamPolicy
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. |
region_set_policy_request_resource |
google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &
The RegionSetPolicyRequest 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 |
SetIamPolicy(google::cloud::cpp::compute::region_backend_services::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::SetIamPolicyRequest 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::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 |
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 backend service.
For more information, see Google Cloud Armor Overview https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/setSecurityPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
SetSecurityPolicy(google::cloud::cpp::compute::region_backend_services::v1::SetSecurityPolicyRequest const &, Options)
Sets the Google Cloud Armor security policy for the specified backend service.
For more information, see Google Cloud Armor Overview https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices/setSecurityPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::SetSecurityPolicyRequest 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 |
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::region_backend_services::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::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 |
UpdateBackendService(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendService const &, Options)
Updates the specified regional 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/regionBackendServices/update
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping 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 |
UpdateBackendService(google::cloud::cpp::compute::region_backend_services::v1::UpdateBackendServiceRequest const &, Options)
Updates the specified regional 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/regionBackendServices/update
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_backend_services::v1::UpdateBackendServiceRequest 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 |