(::String) — An optional string description of this rule.
This field has a maximum length of 100 characters.
#description=
defdescription=(value)->::String
Parameter
value (::String) — An optional string description of this rule.
This field has a maximum length of 100 characters.
Returns
(::String) — An optional string description of this rule.
This field has a maximum length of 100 characters.
#priority
defpriority()->::Integer
Returns
(::Integer) — 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.
#priority=
defpriority=(value)->::Integer
Parameter
value (::Integer) — 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
(::Integer) — 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.
#source_range
defsource_range()->::String
Returns
(::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.1 or 192.168.0.0/16 or 2001:db8::/32
or 2001: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/24 is accepted as the same
address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted
as the same address as 2001:db8::/32.
#source_range=
defsource_range=(value)->::String
Parameter
value (::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.1 or 192.168.0.0/16 or 2001:db8::/32
or 2001: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/24 is accepted as the same
address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted
as the same address as 2001:db8::/32.
Returns
(::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.1 or 192.168.0.0/16 or 2001:db8::/32
or 2001: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/24 is accepted as the same
address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted
as the same address as 2001:db8::/32.
[[["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,["# App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::FirewallRule (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Cloud-AppEngine-V1-FirewallRule)\n- [1.2.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.2.1/Google-Cloud-AppEngine-V1-FirewallRule)\n- [1.1.0](/ruby/docs/reference/google-cloud-app_engine-v1/1.1.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [1.0.1](/ruby/docs/reference/google-cloud-app_engine-v1/1.0.1/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.10.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.10.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.9.2](/ruby/docs/reference/google-cloud-app_engine-v1/0.9.2/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.8.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.8.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.7.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.7.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.6.1](/ruby/docs/reference/google-cloud-app_engine-v1/0.6.1/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.5.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.5.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.4.0](/ruby/docs/reference/google-cloud-app_engine-v1/0.4.0/Google-Cloud-AppEngine-V1-FirewallRule)\n- [0.3.6](/ruby/docs/reference/google-cloud-app_engine-v1/0.3.6/Google-Cloud-AppEngine-V1-FirewallRule) \nReference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::FirewallRule.\n\nA single firewall rule that is evaluated against incoming traffic\nand provides an action to take on matched requests. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #action\n\n def action() -\u003e ::Google::Cloud::AppEngine::V1::FirewallRule::Action\n\n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::FirewallRule::Action](./Google-Cloud-AppEngine-V1-FirewallRule-Action)) --- The action to take on matched requests.\n\n### #action=\n\n def action=(value) -\u003e ::Google::Cloud::AppEngine::V1::FirewallRule::Action\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AppEngine::V1::FirewallRule::Action](./Google-Cloud-AppEngine-V1-FirewallRule-Action)) --- The action to take on matched requests. \n**Returns**\n\n- ([::Google::Cloud::AppEngine::V1::FirewallRule::Action](./Google-Cloud-AppEngine-V1-FirewallRule-Action)) --- The action to take on matched requests.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- An optional string description of this rule. This field has a maximum length of 100 characters.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- An optional string description of this rule. This field has a maximum length of 100 characters. \n**Returns**\n\n- (::String) --- An optional string description of this rule. This field has a maximum length of 100 characters.\n\n### #priority\n\n def priority() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- A positive integer between \\[1, Int32.MaxValue-1\\] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.\n\n A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic\n when no previous rule matches. Only the action of this rule can be modified\n by the user.\n\n### #priority=\n\n def priority=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- A positive integer between \\[1, Int32.MaxValue-1\\] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.\n\n\n A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic\n when no previous rule matches. Only the action of this rule can be modified\nby the user. \n**Returns**\n\n- (::Integer) --- A positive integer between \\[1, Int32.MaxValue-1\\] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.\n\n A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic\n when no previous rule matches. Only the action of this rule can be modified\n by the user.\n\n### #source_range\n\n def source_range() -\u003e ::String\n\n**Returns**\n\n- (::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.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\n\n \u003cbr /\u003e\n\n Truncation will be silently performed on addresses which are not\n properly truncated. For example, `1.2.3.4/24` is accepted as the same\n address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted\n as the same address as `2001:db8::/32`.\n\n### #source_range=\n\n def source_range=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\n\n \u003cbr /\u003e\n\n Truncation will be silently performed on addresses which are not\n properly truncated. For example, `1.2.3.4/24` is accepted as the same\n address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted\nas the same address as `2001:db8::/32`. \n**Returns**\n\n- (::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.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\n\n \u003cbr /\u003e\n\n Truncation will be silently performed on addresses which are not\n properly truncated. For example, `1.2.3.4/24` is accepted as the same\n address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted\n as the same address as `2001:db8::/32`."]]