Compute V1 Client - Class RouterNatRule (1.18.0)

Version 1.18.0

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Reference documentation and code samples for the Compute V1 Client class RouterNatRule.

Generated from protobuf message google.cloud.compute.v1.RouterNatRule

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ action	Google\Cloud\Compute\V1\RouterNatRuleAction The action to be enforced for traffic that matches this rule.
↳ description	string An optional description of this rule.
↳ match	string CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'"
↳ rule_number	int An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

getAction

The action to be enforced for traffic that matches this rule.

Returns
Type	Description
Google\Cloud\Compute\V1\RouterNatRuleAction|null

hasAction

clearAction

setAction

The action to be enforced for traffic that matches this rule.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\RouterNatRuleAction

Returns
Type	Description
$this

getDescription

An optional description of this rule.

Returns
Type	Description
string

hasDescription

clearDescription

setDescription

An optional description of this rule.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMatch

CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'"

Returns
Type	Description
string

hasMatch

clearMatch

setMatch

CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding action is enforced. The following examples are valid match expressions for public NAT: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The following example is a valid match expression for private NAT: "nexthop.hub == '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRuleNumber

An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Returns
Type	Description
int

hasRuleNumber

clearRuleNumber

setRuleNumber

An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Parameter
Name	Description
var	int

Returns
Type	Description
$this