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"].
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class RouterStatusNatStatusNatRuleStatus (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.RouterStatusNatStatusNatRuleStatus)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.RouterStatusNatStatusNatRuleStatus) \nReference documentation and code samples for the Compute V1 Client class RouterStatusNatStatusNatRuleStatus.\n\nStatus of a NAT Rule contained in this NAT.\n\nGenerated from protobuf message `google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getActiveNatIps\n\nA list of active IPs for NAT. Example: \\[\"1.1.1.1\", \"179.12.26.133\"\\].\n\n### setActiveNatIps\n\nA list of active IPs for NAT. Example: \\[\"1.1.1.1\", \"179.12.26.133\"\\].\n\n### getDrainNatIps\n\nA list of IPs for NAT that are in drain mode. Example: \\[\"1.1.1.1\", \"179.12.26.133\"\\].\n\n### setDrainNatIps\n\nA list of IPs for NAT that are in drain mode. Example: \\[\"1.1.1.1\", \"179.12.26.133\"\\].\n\n### getMinExtraIpsNeeded\n\nThe 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.\n\n### hasMinExtraIpsNeeded\n\n### clearMinExtraIpsNeeded\n\n### setMinExtraIpsNeeded\n\nThe 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.\n\n### getNumVmEndpointsWithNatMappings\n\nNumber of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.\n\n### hasNumVmEndpointsWithNatMappings\n\n### clearNumVmEndpointsWithNatMappings\n\n### setNumVmEndpointsWithNatMappings\n\nNumber of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.\n\n### getRuleNumber\n\nRule number of the rule.\n\n### hasRuleNumber\n\n### clearRuleNumber\n\n### setRuleNumber\n\nRule number of the rule."]]
