Compute V1 Client - Class RouterStatusNatStatus (2.4.0)

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

Status of a NAT contained in this router.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ auto_allocated_nat_ips
array

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

↳ drain_auto_allocated_nat_ips
array

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

↳ drain_user_allocated_nat_ips
array

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

↳ min_extra_nat_ips_needed
int

Output only. The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used.

↳ name
string

Output only. Unique name of this NAT.

↳ num_vm_endpoints_with_nat_mappings
int

Output only. Number of VM endpoints (i.e., Nics) that can use NAT.

↳ rule_status
array< RouterStatusNatStatusNatRuleStatus >

Status of rules in this NAT.

↳ user_allocated_nat_ip_resources
array

Output only. A list of fully qualified URLs of reserved IP address resources.

↳ user_allocated_nat_ips
array

Output only. A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

getAutoAllocatedNatIps

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

Returns
Type
Description

setAutoAllocatedNatIps

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

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

getDrainAutoAllocatedNatIps

Output only. A list of IPs auto-allocated for NAT that are in drain mode.

Example: ["1.1.1.1", "179.12.26.133"].

Returns
Type
Description

setDrainAutoAllocatedNatIps

Output only. A list of IPs auto-allocated 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

getDrainUserAllocatedNatIps

Output only. A list of IPs user-allocated for NAT that are in drain mode.

Example: ["1.1.1.1", "179.12.26.133"].

Returns
Type
Description

setDrainUserAllocatedNatIps

Output only. A list of IPs user-allocated 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

getMinExtraNatIpsNeeded

Output only. The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT.

This value is meaningful only when auto-allocation of NAT IPs is not used.

Returns
Type
Description
int

hasMinExtraNatIpsNeeded

clearMinExtraNatIpsNeeded

setMinExtraNatIpsNeeded

Output only. The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT.

This value is meaningful only when auto-allocation of NAT IPs is not used.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getName

Output only. Unique name of this NAT.

Returns
Type
Description
string

hasName

clearName

setName

Output only. Unique name of this NAT.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNumVmEndpointsWithNatMappings

Output only. Number of VM endpoints (i.e., Nics) that can use NAT.

Returns
Type
Description
int

hasNumVmEndpointsWithNatMappings

clearNumVmEndpointsWithNatMappings

setNumVmEndpointsWithNatMappings

Output only. Number of VM endpoints (i.e., Nics) that can use NAT.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getRuleStatus

Status of rules in this NAT.

Returns
Type
Description

setRuleStatus

Status of rules in this NAT.

Parameter
Name
Description
Returns
Type
Description
$this

getUserAllocatedNatIpResources

Output only. A list of fully qualified URLs of reserved IP address resources.

Returns
Type
Description

setUserAllocatedNatIpResources

Output only. A list of fully qualified URLs of reserved IP address resources.

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

getUserAllocatedNatIps

Output only. A list of IPs user-allocated for NAT.

They will be raw IP strings like "179.12.26.133".

Returns
Type
Description

setUserAllocatedNatIps

Output only. A list of IPs user-allocated for NAT.

They will be raw IP strings like "179.12.26.133".

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: