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
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"].
Generated from protobuf field repeated string active_nat_ips = 208517077;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setActiveNatIps
A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].
Generated from protobuf field repeated string active_nat_ips = 208517077;
| 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"].
Generated from protobuf field repeated string drain_nat_ips = 504078535;
| 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"].
Generated from protobuf field repeated string drain_nat_ips = 504078535;
| 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.
Generated from protobuf field optional int32 min_extra_ips_needed = 353002756;
| 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.
Generated from protobuf field optional int32 min_extra_ips_needed = 353002756;
| 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.
Generated from protobuf field optional int32 num_vm_endpoints_with_nat_mappings = 512367468;
| Returns | |
|---|---|
| Type | Description |
int | |
hasNumVmEndpointsWithNatMappings
clearNumVmEndpointsWithNatMappings
setNumVmEndpointsWithNatMappings
Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.
Generated from protobuf field optional int32 num_vm_endpoints_with_nat_mappings = 512367468;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRuleNumber
Rule number of the rule.
Generated from protobuf field optional int32 rule_number = 535211500;
| Returns | |
|---|---|
| Type | Description |
int | |
hasRuleNumber
clearRuleNumber
setRuleNumber
Rule number of the rule.
Generated from protobuf field optional int32 rule_number = 535211500;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |