Service for the resourcePolicies resource.
https://cloud.google.com/compute/docs/reference/rest/v1/resourcePolicies
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
ResourcePoliciesClient(ResourcePoliciesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ResourcePoliciesClient const &
|
ResourcePoliciesClient(ResourcePoliciesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ResourcePoliciesClient &&
|
ResourcePoliciesClient(std::shared_ptr< ResourcePoliciesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ResourcePoliciesConnection >
|
opts |
Options
|
Operators
operator=(ResourcePoliciesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ResourcePoliciesClient const &
|
Returns | |
---|---|
Type | Description |
ResourcePoliciesClient & |
operator=(ResourcePoliciesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ResourcePoliciesClient &&
|
Returns | |
---|---|
Type | Description |
ResourcePoliciesClient & |
Functions
AggregatedListResourcePolicies(std::string const &, Options)
Retrieves an aggregated list of resource policies.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/resourcePolicies/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::ResourcePoliciesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListResourcePolicies(google::cloud::cpp::compute::resource_policies::v1::AggregatedListResourcePoliciesRequest, Options)
Retrieves an aggregated list of resource policies.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/resourcePolicies/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::AggregatedListResourcePoliciesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::ResourcePoliciesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteResourcePolicy(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified resource policy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
resource_policy |
std::string const &
Name of the resource policy 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 |
DeleteResourcePolicy(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
resource_policy |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteResourcePolicy(google::cloud::cpp::compute::resource_policies::v1::DeleteResourcePolicyRequest const &, Options)
Deletes the specified resource policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::DeleteResourcePolicyRequest 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 |
DeleteResourcePolicy(NoAwaitTag, google::cloud::cpp::compute::resource_policies::v1::DeleteResourcePolicyRequest const &, Options)
Deletes the specified resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::resource_policies::v1::DeleteResourcePolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteResourcePolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified resource policy.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetResourcePolicy(std::string const &, std::string const &, std::string const &, Options)
Retrieves all information of the specified resource policy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
resource_policy |
std::string const &
Name of the resource policy to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::ResourcePolicy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ResourcePolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetResourcePolicy(google::cloud::cpp::compute::resource_policies::v1::GetResourcePolicyRequest const &, Options)
Retrieves all information of the specified resource policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::GetResourcePolicyRequest 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::ResourcePolicy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ResourcePolicy) 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/resourcePolicies/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::resource_policies::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/resourcePolicies/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::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 |
InsertResourcePolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::ResourcePolicy const &, Options)
Creates a new resource policy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
resource_policy_resource |
google::cloud::cpp::compute::v1::ResourcePolicy const &
The ResourcePolicy 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 |
InsertResourcePolicy(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ResourcePolicy const &, Options)
Creates a new resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
resource_policy_resource |
google::cloud::cpp::compute::v1::ResourcePolicy const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertResourcePolicy(google::cloud::cpp::compute::resource_policies::v1::InsertResourcePolicyRequest const &, Options)
Creates a new resource policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::InsertResourcePolicyRequest 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 |
InsertResourcePolicy(NoAwaitTag, google::cloud::cpp::compute::resource_policies::v1::InsertResourcePolicyRequest const &, Options)
Creates a new resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::resource_policies::v1::InsertResourcePolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertResourcePolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a new resource policy.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListResourcePolicies(std::string const &, std::string const &, Options)
A list all the resource policies that have been configured for the specified project in specified region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::ResourcePolicy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListResourcePolicies(google::cloud::cpp::compute::resource_policies::v1::ListResourcePoliciesRequest, Options)
A list all the resource policies that have been configured for the specified project in specified region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::ListResourcePoliciesRequest
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::ResourcePolicy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchResourcePolicy(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ResourcePolicy const &, Options)
Modify the specified resource policy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
resource_policy |
std::string const &
Id of the resource policy to patch. |
update_mask |
std::string const &
update_mask indicates fields to be updated as part of this request. |
resource_policy_resource |
google::cloud::cpp::compute::v1::ResourcePolicy const &
The ResourcePolicy 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 |
PatchResourcePolicy(NoAwaitTag, std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ResourcePolicy const &, Options)
Modify the specified resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
resource_policy |
std::string const &
|
update_mask |
std::string const &
|
resource_policy_resource |
google::cloud::cpp::compute::v1::ResourcePolicy const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchResourcePolicy(google::cloud::cpp::compute::resource_policies::v1::PatchResourcePolicyRequest const &, Options)
Modify the specified resource policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::v1::PatchResourcePolicyRequest 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 |
PatchResourcePolicy(NoAwaitTag, google::cloud::cpp::compute::resource_policies::v1::PatchResourcePolicyRequest const &, Options)
Modify the specified resource policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::resource_policies::v1::PatchResourcePolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchResourcePolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Modify the specified resource policy.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
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/resourcePolicies/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::resource_policies::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/resourcePolicies/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::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 |
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::resource_policies::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::resource_policies::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 |