Compute V1 Client - Class FirewallPolicyRule (1.5.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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ action string

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

↳ 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. Always compute#firewallPolicyRule for firewall policy rules

↳ match Google\Cloud\Compute\V1\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 prority.

↳ 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.

↳ 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<Google\Cloud\Compute\V1\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.

getAction

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

Generated from protobuf field optional string action = 187661878;

Returns
TypeDescription
string

hasAction

clearAction

setAction

The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

Generated from protobuf field optional string action = 187661878;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

An optional description for this resource.

Generated from protobuf field optional string description = 422937596;

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

An optional description for this resource.

Generated from protobuf field optional string description = 422937596;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDirection

The direction in which this rule applies.

Check the Direction enum for the list of possible values.

Generated from protobuf field optional string direction = 111150975;

Returns
TypeDescription
string

hasDirection

clearDirection

setDirection

The direction in which this rule applies.

Check the Direction enum for the list of possible values.

Generated from protobuf field optional string direction = 111150975;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional bool disabled = 270940796;

Returns
TypeDescription
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.

Generated from protobuf field optional bool disabled = 270940796;

Parameter
NameDescription
var bool
Returns
TypeDescription
$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.

Generated from protobuf field optional bool enable_logging = 295396515;

Returns
TypeDescription
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.

Generated from protobuf field optional bool enable_logging = 295396515;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getKind

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMatch

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

Generated from protobuf field optional .google.cloud.compute.v1.FirewallPolicyRuleMatcher match = 103668165;

Returns
TypeDescription
Google\Cloud\Compute\V1\FirewallPolicyRuleMatcher|null

hasMatch

clearMatch

setMatch

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

Generated from protobuf field optional .google.cloud.compute.v1.FirewallPolicyRuleMatcher match = 103668165;

Parameter
NameDescription
var Google\Cloud\Compute\V1\FirewallPolicyRuleMatcher
Returns
TypeDescription
$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 prority.

Generated from protobuf field optional int32 priority = 445151652;

Returns
TypeDescription
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 prority.

Generated from protobuf field optional int32 priority = 445151652;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRuleName

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

Generated from protobuf field optional string rule_name = 55286254;

Returns
TypeDescription
string

hasRuleName

clearRuleName

setRuleName

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

Generated from protobuf field optional string rule_name = 55286254;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRuleTupleCount

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

Generated from protobuf field optional int32 rule_tuple_count = 388342037;

Returns
TypeDescription
int

hasRuleTupleCount

clearRuleTupleCount

setRuleTupleCount

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

Generated from protobuf field optional int32 rule_tuple_count = 388342037;

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field repeated string target_resources = 528230647;

Returns
TypeDescription
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.

Generated from protobuf field repeated string target_resources = 528230647;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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.

Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

Returns
TypeDescription
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.

Generated from protobuf field repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\FirewallPolicyRuleSecureTag>
Returns
TypeDescription
$this

getTargetServiceAccounts

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

Generated from protobuf field repeated string target_service_accounts = 457639710;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTargetServiceAccounts

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

Generated from protobuf field repeated string target_service_accounts = 457639710;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this