Compute V1 Client - Class RouterStatusNatStatusNatRuleStatus (1.10.1)

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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ active_nat_ipsarray

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

↳ drain_nat_ipsarray

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

↳ min_extra_ips_neededint

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_mappingsint

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

↳ rule_numberint

Rule number of the rule.

getActiveNatIps

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setActiveNatIps

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

Parameter
NameDescription
varstring[]
Returns
TypeDescription
$this

getDrainNatIps

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

Returns
TypeDescription
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
NameDescription
varstring[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
varint
Returns
TypeDescription
$this

getNumVmEndpointsWithNatMappings

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

Returns
TypeDescription
int

hasNumVmEndpointsWithNatMappings

clearNumVmEndpointsWithNatMappings

setNumVmEndpointsWithNatMappings

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

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getRuleNumber

Rule number of the rule.

Returns
TypeDescription
int

hasRuleNumber

clearRuleNumber

setRuleNumber

Rule number of the rule.

Parameter
NameDescription
varint
Returns
TypeDescription
$this