class FirewallPolicies extends Resource (View source)

The "firewallPolicies" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $firewallPolicies = $computeService->firewallPolicies;

Methods

addAssociation(string $firewallPolicy, FirewallPolicyAssociation $postBody, array $optParams = [])

Inserts an association for the specified firewall policy.

addRule(string $firewallPolicy, FirewallPolicyRule $postBody, array $optParams = [])

Inserts a rule into a firewall policy. (firewallPolicies.addRule)

cloneRules(string $firewallPolicy, array $optParams = [])

Copies rules to the specified firewall policy. (firewallPolicies.cloneRules)

delete(string $firewallPolicy, array $optParams = [])

Deletes the specified policy. (firewallPolicies.delete)

get(string $firewallPolicy, array $optParams = [])

Returns the specified firewall policy. (firewallPolicies.get)

getAssociation(string $firewallPolicy, array $optParams = [])

Gets an association with the specified name.

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (firewallPolicies.getIamPolicy)

getRule(string $firewallPolicy, array $optParams = [])

Gets a rule of the specified priority. (firewallPolicies.getRule)

insert(FirewallPolicy $postBody, array $optParams = [])

Creates a new policy in the specified project using the data included in the request. (firewallPolicies.insert)

listFirewallPolicies(array $optParams = [])

Lists all the policies that have been configured for the specified folder or organization. (firewallPolicies.listFirewallPolicies)

listAssociations(array $optParams = [])

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

move(string $firewallPolicy, array $optParams = [])

Moves the specified firewall policy. (firewallPolicies.move)

patch(string $firewallPolicy, FirewallPolicy $postBody, array $optParams = [])

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

patchRule(string $firewallPolicy, FirewallPolicyRule $postBody, array $optParams = [])

Patches a rule of the specified priority. (firewallPolicies.patchRule)

removeAssociation(string $firewallPolicy, array $optParams = [])

Removes an association for the specified firewall policy.

removeRule(string $firewallPolicy, array $optParams = [])

Deletes a rule of the specified priority. (firewallPolicies.removeRule)

setIamPolicy(string $resource, GlobalOrganizationSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (firewallPolicies.setIamPolicy)

testIamPermissions(string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

Details

Operation addAssociation(string $firewallPolicy, FirewallPolicyAssociation $postBody, array $optParams = [])

Inserts an association for the specified firewall policy.

(firewallPolicies.addAssociation)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

FirewallPolicyAssociation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation addRule(string $firewallPolicy, FirewallPolicyRule $postBody, array $optParams = [])

Inserts a rule into a firewall policy. (firewallPolicies.addRule)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

FirewallPolicyRule $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation cloneRules(string $firewallPolicy, array $optParams = [])

Copies rules to the specified firewall policy. (firewallPolicies.cloneRules)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $firewallPolicy, array $optParams = [])

Deletes the specified policy. (firewallPolicies.delete)

Parameters

string $firewallPolicy

Name of the firewall policy to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

FirewallPolicy get(string $firewallPolicy, array $optParams = [])

Returns the specified firewall policy. (firewallPolicies.get)

Parameters

string $firewallPolicy

Name of the firewall policy to get.

array $optParams

Optional parameters.

Return Value

FirewallPolicy

Exceptions

Exception

FirewallPolicyAssociation getAssociation(string $firewallPolicy, array $optParams = [])

Gets an association with the specified name.

(firewallPolicies.getAssociation)

Parameters

string $firewallPolicy

Name of the firewall policy to which the queried rule belongs.

array $optParams

Optional parameters.

Return Value

FirewallPolicyAssociation

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (firewallPolicies.getIamPolicy)

Parameters

string $resource

Name or id of the resource for this request.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

FirewallPolicyRule getRule(string $firewallPolicy, array $optParams = [])

Gets a rule of the specified priority. (firewallPolicies.getRule)

Parameters

string $firewallPolicy

Name of the firewall policy to which the queried rule belongs.

array $optParams

Optional parameters.

Return Value

FirewallPolicyRule

Exceptions

Exception

Operation insert(FirewallPolicy $postBody, array $optParams = [])

Creates a new policy in the specified project using the data included in the request. (firewallPolicies.insert)

Parameters

FirewallPolicy $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

FirewallPolicyList listFirewallPolicies(array $optParams = [])

Lists all the policies that have been configured for the specified folder or organization. (firewallPolicies.listFirewallPolicies)

Parameters

array $optParams

Optional parameters.

Return Value

FirewallPolicyList

Exceptions

Exception

FirewallPoliciesListAssociationsResponse listAssociations(array $optParams = [])

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

(firewallPolicies.listAssociations)

Parameters

array $optParams

Optional parameters.

Return Value

FirewallPoliciesListAssociationsResponse

Exceptions

Exception

Operation move(string $firewallPolicy, array $optParams = [])

Moves the specified firewall policy. (firewallPolicies.move)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation patch(string $firewallPolicy, FirewallPolicy $postBody, array $optParams = [])

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

(firewallPolicies.patch)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

FirewallPolicy $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation patchRule(string $firewallPolicy, FirewallPolicyRule $postBody, array $optParams = [])

Patches a rule of the specified priority. (firewallPolicies.patchRule)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

FirewallPolicyRule $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation removeAssociation(string $firewallPolicy, array $optParams = [])

Removes an association for the specified firewall policy.

(firewallPolicies.removeAssociation)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation removeRule(string $firewallPolicy, array $optParams = [])

Deletes a rule of the specified priority. (firewallPolicies.removeRule)

Parameters

string $firewallPolicy

Name of the firewall policy to update.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, GlobalOrganizationSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (firewallPolicies.setIamPolicy)

Parameters

string $resource

Name or id of the resource for this request.

GlobalOrganizationSetPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestPermissionsResponse testIamPermissions(string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(firewallPolicies.testIamPermissions)

Parameters

string $resource

Name or id of the resource for this request.

TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception