Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class FirewallRule.
A single firewall rule that is evaluated against incoming traffic
and provides an action to take on matched requests.
Generated from protobuf messagegoogle.appengine.v1.FirewallRule
Namespace
Google \ Cloud \ AppEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ priority
int
A positive integer between [1, Int32.MaxValue-1] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first. A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
↳ action
int
The action to take on matched requests.
↳ source_range
string
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples:192.168.1.1or192.168.0.0/16or2001:db8::/32or2001:0db8:0000:0042:0000:8a2e:0370:7334.
Truncation will be silently performed on addresses which are not properly truncated. For example,1.2.3.4/24is accepted as the same address as1.2.3.0/24. Similarly, for IPv6,2001:db8::1/32is accepted as the same address as2001:db8::/32.
↳ description
string
An optional string description of this rule. This field has a maximum length of 100 characters.
getPriority
A positive integer between [1, Int32.MaxValue-1] that defines the order of
rule evaluation. Rules with the lowest priority are evaluated first.
A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
when no previous rule matches. Only the action of this rule can be modified
by the user.
Returns
Type
Description
int
setPriority
A positive integer between [1, Int32.MaxValue-1] that defines the order of
rule evaluation. Rules with the lowest priority are evaluated first.
A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
when no previous rule matches. Only the action of this rule can be modified
by the user.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getAction
The action to take on matched requests.
Returns
Type
Description
int
setAction
The action to take on matched requests.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getSourceRange
IP address or range, defined using CIDR notation, of requests that this
rule applies to. You can use the wildcard character "*" to match all IPs
equivalent to "0/0" and "::/0" together.
Truncation will be silently performed on addresses which are not
properly truncated. For example,1.2.3.4/24is accepted as the same
address as1.2.3.0/24. Similarly, for IPv6,2001:db8::1/32is accepted
as the same address as2001:db8::/32.
Returns
Type
Description
string
setSourceRange
IP address or range, defined using CIDR notation, of requests that this
rule applies to. You can use the wildcard character "*" to match all IPs
equivalent to "0/0" and "::/0" together.
Truncation will be silently performed on addresses which are not
properly truncated. For example,1.2.3.4/24is accepted as the same
address as1.2.3.0/24. Similarly, for IPv6,2001:db8::1/32is accepted
as the same address as2001:db8::/32.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
An optional string description of this rule.
This field has a maximum length of 100 characters.
Returns
Type
Description
string
setDescription
An optional string description of this rule.
This field has a maximum length of 100 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Appengine Admin V1 Client - Class FirewallRule (2.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.4 (latest)](/php/docs/reference/cloud-appengine-admin/latest/V1.FirewallRule)\n- [2.0.3](/php/docs/reference/cloud-appengine-admin/2.0.3/V1.FirewallRule)\n- [1.3.5](/php/docs/reference/cloud-appengine-admin/1.3.5/V1.FirewallRule)\n- [1.2.2](/php/docs/reference/cloud-appengine-admin/1.2.2/V1.FirewallRule)\n- [1.1.1](/php/docs/reference/cloud-appengine-admin/1.1.1/V1.FirewallRule)\n- [1.0.6](/php/docs/reference/cloud-appengine-admin/1.0.6/V1.FirewallRule) \nReference documentation and code samples for the Google Cloud Appengine Admin V1 Client class FirewallRule.\n\nA single firewall rule that is evaluated against incoming traffic\nand provides an action to take on matched requests.\n\nGenerated from protobuf message `google.appengine.v1.FirewallRule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AppEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPriority\n\nA positive integer between \\[1, Int32.MaxValue-1\\] that defines the order of\nrule evaluation. Rules with the lowest priority are evaluated first.\n\nA default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic\nwhen no previous rule matches. Only the action of this rule can be modified\nby the user.\n\n### setPriority\n\nA positive integer between \\[1, Int32.MaxValue-1\\] that defines the order of\nrule evaluation. Rules with the lowest priority are evaluated first.\n\nA default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic\nwhen no previous rule matches. Only the action of this rule can be modified\nby the user.\n\n### getAction\n\nThe action to take on matched requests.\n\n### setAction\n\nThe action to take on matched requests.\n\n### getSourceRange\n\nIP address or range, defined using CIDR notation, of requests that this\nrule applies to. You can use the wildcard character \"\\*\" to match all IPs\nequivalent to \"0/0\" and \"::/0\" together.\n\nExamples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`\nor `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\nTruncation will be silently performed on addresses which are not\nproperly truncated. For example, `1.2.3.4/24` is accepted as the same\naddress as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted\nas the same address as `2001:db8::/32`.\n\n### setSourceRange\n\nIP address or range, defined using CIDR notation, of requests that this\nrule applies to. You can use the wildcard character \"\\*\" to match all IPs\nequivalent to \"0/0\" and \"::/0\" together.\n\nExamples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`\nor `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\nTruncation will be silently performed on addresses which are not\nproperly truncated. For example, `1.2.3.4/24` is accepted as the same\naddress as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted\nas the same address as `2001:db8::/32`.\n\n### getDescription\n\nAn optional string description of this rule.\n\nThis field has a maximum length of 100 characters.\n\n### setDescription\n\nAn optional string description of this rule.\n\nThis field has a maximum length of 100 characters."]]
