Compute V1 Client - Class RouterStatusNatStatus (1.5.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

Methods

__construct

Constructor.

Parameters
Name
Description
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"]

Generated from protobuf field repeated string auto_allocated_nat_ips = 510794246;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setAutoAllocatedNatIps

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

Generated from protobuf field repeated string auto_allocated_nat_ips = 510794246;

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

getDrainAutoAllocatedNatIps

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

Generated from protobuf field repeated string drain_auto_allocated_nat_ips = 309184557;

Returns
Type
Description
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"].

Generated from protobuf field repeated string drain_auto_allocated_nat_ips = 309184557;

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

getDrainUserAllocatedNatIps

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

Generated from protobuf field repeated string drain_user_allocated_nat_ips = 305268553;

Returns
Type
Description
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"].

Generated from protobuf field repeated string drain_user_allocated_nat_ips = 305268553;

Parameter
Name
Description
var
string[]
Returns
Type
Description
$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.

Generated from protobuf field optional int32 min_extra_nat_ips_needed = 365786338;

Returns
Type
Description
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.

Generated from protobuf field optional int32 min_extra_nat_ips_needed = 365786338;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getName

Unique name of this NAT.

Generated from protobuf field optional string name = 3373707;

Returns
Type
Description
string

hasName

clearName

setName

Unique name of this NAT.

Generated from protobuf field optional string name = 3373707;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNumVmEndpointsWithNatMappings

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

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 can use NAT.

Generated from protobuf field optional int32 num_vm_endpoints_with_nat_mappings = 512367468;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getRuleStatus

Status of rules in this NAT.

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setRuleStatus

Status of rules in this NAT.

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Parameter
Name
Description
Returns
Type
Description
$this

getUserAllocatedNatIpResources

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

Generated from protobuf field repeated string user_allocated_nat_ip_resources = 212776151;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setUserAllocatedNatIpResources

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

Generated from protobuf field repeated string user_allocated_nat_ip_resources = 212776151;

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

getUserAllocatedNatIps

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

Generated from protobuf field repeated string user_allocated_nat_ips = 506878242;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setUserAllocatedNatIps

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

Generated from protobuf field repeated string user_allocated_nat_ips = 506878242;

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