Compute V1 Client - Class FirewallPolicyRule (1.22.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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".

Returns
Type Description
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".

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description for this resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description for this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDirection

The direction in which this rule applies.

Check the Direction enum for the list of possible values.

Returns
Type Description
string

hasDirection

clearDirection

setDirection

The direction in which this rule applies.

Check the Direction enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getKind

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.

Parameter
Name Description
var string
Returns
Type Description
$this

getMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

Returns
Type Description
FirewallPolicyRuleMatcher|null

hasMatch

clearMatch

setMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

Parameter
Name Description
var FirewallPolicyRuleMatcher
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$this

getRuleName

An optional name for the rule. This field is not a unique identifier and can be updated.

Returns
Type Description
string

hasRuleName

clearRuleName

setRuleName

An optional name for the rule. This field is not a unique identifier and can be updated.

Parameter
Name Description
var string
Returns
Type Description
$this

getRuleTupleCount

[Output Only] Calculation of the complexity of a single firewall policy rule.

Returns
Type Description
int

hasRuleTupleCount

clearRuleTupleCount

setRuleTupleCount

[Output Only] Calculation of the complexity of a single firewall policy rule.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name Description
var string[]
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name Description
var array<FirewallPolicyRuleSecureTag>
Returns
Type Description
$this

getTargetServiceAccounts

A list of service accounts indicating the sets of instances that are applied with this rule.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTargetServiceAccounts

A list of service accounts indicating the sets of instances that are applied with this rule.

Parameter
Name Description
var string[]
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this