Class FirewallPoliciesClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the firewallPolicies resource.

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

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

FirewallPoliciesClient(FirewallPoliciesClient const &)

Copy and move support

Parameter
Name	Description
	FirewallPoliciesClient const &

FirewallPoliciesClient(FirewallPoliciesClient &&)

Copy and move support

Parameter
Name	Description
	FirewallPoliciesClient &&

FirewallPoliciesClient(std::shared_ptr< FirewallPoliciesConnection >, Options)

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

Operators

operator=(FirewallPoliciesClient const &)

Copy and move support

Parameter
Name	Description
	FirewallPoliciesClient const &

Returns
Type	Description
FirewallPoliciesClient &

operator=(FirewallPoliciesClient &&)

Copy and move support

Parameter
Name	Description
	FirewallPoliciesClient &&

Returns
Type	Description
FirewallPoliciesClient &

Functions

AddAssociation(std::string const &, google::cloud::cpp::compute::v1::FirewallPolicyAssociation const &, Options)

Inserts an association for the specified firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
firewall_policy_association_resource	google::cloud::cpp::compute::v1::FirewallPolicyAssociation const & The FirewallPolicyAssociation 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.

AddAssociation(google::cloud::cpp::compute::firewall_policies::v1::AddAssociationRequest const &, Options)

Inserts an association for the specified firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::AddAssociationRequest 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.firewall_policies.v1.AddAssociationRequest. 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.

AddRule(std::string const &, google::cloud::cpp::compute::v1::FirewallPolicyRule const &, Options)

Inserts a rule into a firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
firewall_policy_rule_resource	google::cloud::cpp::compute::v1::FirewallPolicyRule const & The FirewallPolicyRule 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.

AddRule(google::cloud::cpp::compute::firewall_policies::v1::AddRuleRequest const &, Options)

Inserts a rule into a firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::AddRuleRequest 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.firewall_policies.v1.AddRuleRequest. 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.

CloneRules(std::string const &, Options)

Copies rules to the specified firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
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.

CloneRules(google::cloud::cpp::compute::firewall_policies::v1::CloneRulesRequest const &, Options)

Copies rules to the specified firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::CloneRulesRequest 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.firewall_policies.v1.CloneRulesRequest. 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.

DeleteFirewallPolicy(std::string const &, Options)

Deletes the specified policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall 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 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.

DeleteFirewallPolicy(google::cloud::cpp::compute::firewall_policies::v1::DeleteFirewallPolicyRequest const &, Options)

Deletes the specified policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::DeleteFirewallPolicyRequest 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.firewall_policies.v1.DeleteFirewallPolicyRequest. 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.

GetFirewallPolicy(std::string const &, Options)

Returns the specified firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetFirewallPolicy(google::cloud::cpp::compute::firewall_policies::v1::GetFirewallPolicyRequest const &, Options)

Returns the specified firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::GetFirewallPolicyRequest 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.firewall_policies.v1.GetFirewallPolicyRequest. 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::FirewallPolicy >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAssociation(std::string const &, Options)

Gets an association with the specified name.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to which the queried rule belongs.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetAssociation(google::cloud::cpp::compute::firewall_policies::v1::GetAssociationRequest const &, Options)

Gets an association with the specified name.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::GetAssociationRequest 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.firewall_policies.v1.GetAssociationRequest. 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::FirewallPolicyAssociation >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FirewallPolicyAssociation) 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 &, 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/firewallPolicies/getIamPolicy

Parameters
Name	Description
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::firewall_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/firewallPolicies/getIamPolicy

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

GetRule(std::string const &, Options)

Gets a rule of the specified priority.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to which the queried rule belongs.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetRule(google::cloud::cpp::compute::firewall_policies::v1::GetRuleRequest const &, Options)

Gets a rule of the specified priority.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::GetRuleRequest 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.firewall_policies.v1.GetRuleRequest. 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::FirewallPolicyRule >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FirewallPolicyRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertFirewallPolicy(google::cloud::cpp::compute::firewall_policies::v1::InsertFirewallPolicyRequest const &, Options)

Creates a new policy in the specified project using the data included in the request.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::InsertFirewallPolicyRequest 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.firewall_policies.v1.InsertFirewallPolicyRequest. 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.

ListFirewallPolicies(google::cloud::cpp::compute::firewall_policies::v1::ListFirewallPoliciesRequest, Options)

Lists all the policies that have been configured for the specified folder or organization.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::ListFirewallPoliciesRequest 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.firewall_policies.v1.ListFirewallPoliciesRequest. 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::FirewallPolicy >	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.FirewallPolicy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAssociations(google::cloud::cpp::compute::firewall_policies::v1::ListAssociationsRequest const &, Options)

Lists associations of a specified target, i.e., organization or folder.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::ListAssociationsRequest 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.firewall_policies.v1.ListAssociationsRequest. 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::FirewallPoliciesListAssociationsResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FirewallPoliciesListAssociationsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Move(std::string const &, Options)

Moves the specified firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
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.

Move(google::cloud::cpp::compute::firewall_policies::v1::MoveRequest const &, Options)

Moves the specified firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::MoveRequest 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.firewall_policies.v1.MoveRequest. 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.

PatchFirewallPolicy(std::string const &, google::cloud::cpp::compute::v1::FirewallPolicy const &, Options)

Patches the specified policy with the data included in the request.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
firewall_policy_resource	google::cloud::cpp::compute::v1::FirewallPolicy const & The FirewallPolicy 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.

PatchFirewallPolicy(google::cloud::cpp::compute::firewall_policies::v1::PatchFirewallPolicyRequest const &, Options)

Patches the specified policy with the data included in the request.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::PatchFirewallPolicyRequest 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.firewall_policies.v1.PatchFirewallPolicyRequest. 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.

PatchRule(std::string const &, google::cloud::cpp::compute::v1::FirewallPolicyRule const &, Options)

Patches a rule of the specified priority.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
firewall_policy_rule_resource	google::cloud::cpp::compute::v1::FirewallPolicyRule const & The FirewallPolicyRule 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.

PatchRule(google::cloud::cpp::compute::firewall_policies::v1::PatchRuleRequest const &, Options)

Patches a rule of the specified priority.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::PatchRuleRequest 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.firewall_policies.v1.PatchRuleRequest. 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.

RemoveAssociation(std::string const &, Options)

Removes an association for the specified firewall policy.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
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.

RemoveAssociation(google::cloud::cpp::compute::firewall_policies::v1::RemoveAssociationRequest const &, Options)

Removes an association for the specified firewall policy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::RemoveAssociationRequest 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.firewall_policies.v1.RemoveAssociationRequest. 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.

RemoveRule(std::string const &, Options)

Deletes a rule of the specified priority.

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

Parameters
Name	Description
firewall_policy	std::string const & Name of the firewall policy to update.
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.

RemoveRule(google::cloud::cpp::compute::firewall_policies::v1::RemoveRuleRequest const &, Options)

Deletes a rule of the specified priority.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::RemoveRuleRequest 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.firewall_policies.v1.RemoveRuleRequest. 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 &, google::cloud::cpp::compute::v1::GlobalOrganizationSetPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/firewallPolicies/setIamPolicy

Parameters
Name	Description
resource	std::string const & Name or id of the resource for this request.
global_organization_set_policy_request_resource	google::cloud::cpp::compute::v1::GlobalOrganizationSetPolicyRequest const & The GlobalOrganizationSetPolicyRequest 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::firewall_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/firewallPolicies/setIamPolicy

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

TestIamPermissions(std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

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

Parameters
Name	Description
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 StatusOr contains the error details.

TestIamPermissions(google::cloud::cpp::compute::firewall_policies::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::firewall_policies::v1::TestIamPermissionsRequest 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.firewall_policies.v1.TestIamPermissionsRequest. 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::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 StatusOr contains the error details.