Compute V1 Client - Class RouterStatusNatStatusNatRuleStatus (1.17.0)

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

Status of a NAT Rule contained in this NAT.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ active_nat_ips array

A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

↳ drain_nat_ips array

A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

↳ min_extra_ips_needed int

The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

↳ num_vm_endpoints_with_nat_mappings int

Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

↳ rule_number int

Rule number of the rule.

getActiveNatIps

A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActiveNatIps

A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDrainNatIps

A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDrainNatIps

A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMinExtraIpsNeeded

The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

Returns
Type Description
int

hasMinExtraIpsNeeded

clearMinExtraIpsNeeded

setMinExtraIpsNeeded

The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

Parameter
Name Description
var int
Returns
Type Description
$this

getNumVmEndpointsWithNatMappings

Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

Returns
Type Description
int

hasNumVmEndpointsWithNatMappings

clearNumVmEndpointsWithNatMappings

setNumVmEndpointsWithNatMappings

Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

Parameter
Name Description
var int
Returns
Type Description
$this

getRuleNumber

Rule number of the rule.

Returns
Type Description
int

hasRuleNumber

clearRuleNumber

setRuleNumber

Rule number of the rule.

Parameter
Name Description
var int
Returns
Type Description
$this