Reference documentation and code samples for the Compute V1 Client class FirewallPolicyRule.
Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Generated from protobuf message google.cloud.compute.v1.FirewallPolicyRule
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ action
string
The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
↳ description
string
An optional description for this resource.
↳ direction
string
The direction in which this rule applies. Check the Direction enum for the list of possible values.
↳ disabled
bool
Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
↳ enable_logging
bool
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
↳ kind
string
[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
↳ match
FirewallPolicyRuleMatcher
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
↳ priority
int
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
↳ rule_name
string
An optional name for the rule. This field is not a unique identifier and can be updated.
↳ rule_tuple_count
int
[Output Only] Calculation of the complexity of a single firewall policy rule.
↳ security_profile_group
string
A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
↳ target_resources
array
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
↳ target_secure_tags
array< FirewallPolicyRuleSecureTag
>
A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
↳ target_service_accounts
array
A list of service accounts indicating the sets of instances that are applied with this rule.
↳ tls_inspect
bool
Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
getAction
The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
string
hasAction
clearAction
setAction
The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
var
string
$this
getDescription
An optional description for this resource.
string
hasDescription
clearDescription
setDescription
An optional description for this resource.
var
string
$this
getDirection
The direction in which this rule applies.
Check the Direction enum for the list of possible values.
string
hasDirection
clearDirection
setDirection
The direction in which this rule applies.
Check the Direction enum for the list of possible values.
var
string
$this
getDisabled
Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
bool
hasDisabled
clearDisabled
setDisabled
Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
var
bool
$this
getEnableLogging
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
bool
hasEnableLogging
clearEnableLogging
setEnableLogging
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
var
bool
$this
getKind
[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
string
hasKind
clearKind
setKind
[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
var
string
$this
getMatch
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
hasMatch
clearMatch
setMatch
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
$this
getPriority
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
int
hasPriority
clearPriority
setPriority
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
var
int
$this
getRuleName
An optional name for the rule. This field is not a unique identifier and can be updated.
string
hasRuleName
clearRuleName
setRuleName
An optional name for the rule. This field is not a unique identifier and can be updated.
var
string
$this
getRuleTupleCount
[Output Only] Calculation of the complexity of a single firewall policy rule.
int
hasRuleTupleCount
clearRuleTupleCount
setRuleTupleCount
[Output Only] Calculation of the complexity of a single firewall policy rule.
var
int
$this
getSecurityProfileGroup
A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
string
hasSecurityProfileGroup
clearSecurityProfileGroup
setSecurityProfileGroup
A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.
var
string
$this
getTargetResources
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
setTargetResources
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
var
string[]
$this
getTargetSecureTags
A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
setTargetSecureTags
A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
$this
getTargetServiceAccounts
A list of service accounts indicating the sets of instances that are applied with this rule.
setTargetServiceAccounts
A list of service accounts indicating the sets of instances that are applied with this rule.
var
string[]
$this
getTlsInspect
Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
bool
hasTlsInspect
clearTlsInspect
setTlsInspect
Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
var
bool
$this
