Compute V1 Client - Class RouterStatusNatStatus (1.6.1)

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ auto_allocated_nat_ips array

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

↳ drain_auto_allocated_nat_ips array

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

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

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

Unique name of this NAT.

↳ num_vm_endpoints_with_nat_mappings int

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

↳ rule_status array<Google\Cloud\Compute\V1\RouterStatusNatStatusNatRuleStatus>

Status of rules in this NAT.

↳ user_allocated_nat_ip_resources array

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

↳ user_allocated_nat_ips array

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

getAutoAllocatedNatIps

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAutoAllocatedNatIps

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDrainAutoAllocatedNatIps

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDrainAutoAllocatedNatIps

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDrainUserAllocatedNatIps

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDrainUserAllocatedNatIps

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMinExtraNatIpsNeeded

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
TypeDescription
int

hasMinExtraNatIpsNeeded

clearMinExtraNatIpsNeeded

setMinExtraNatIpsNeeded

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
NameDescription
var int
Returns
TypeDescription
$this

getName

Unique name of this NAT.

Returns
TypeDescription
string

hasName

clearName

setName

Unique name of this NAT.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNumVmEndpointsWithNatMappings

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

Returns
TypeDescription
int

hasNumVmEndpointsWithNatMappings

clearNumVmEndpointsWithNatMappings

setNumVmEndpointsWithNatMappings

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRuleStatus

Status of rules in this NAT.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRuleStatus

Status of rules in this NAT.

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\RouterStatusNatStatusNatRuleStatus>
Returns
TypeDescription
$this

getUserAllocatedNatIpResources

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUserAllocatedNatIpResources

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getUserAllocatedNatIps

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUserAllocatedNatIps

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this