Compute V1 Client - Class RouterNat (1.9.1)

Version 1.9.1

• 1.21.0 (latest)
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ drain_nat_ips	array A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.
↳ enable_dynamic_port_allocation	bool Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.
↳ enable_endpoint_independent_mapping	bool
↳ endpoint_types	array List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.
↳ icmp_idle_timeout_sec	int Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
↳ log_config	Google\Cloud\Compute\V1\RouterNatLogConfig Configure logging on this NAT.
↳ max_ports_per_vm	int Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.
↳ min_ports_per_vm	int Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.
↳ name	string Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.
↳ nat_ip_allocate_option	string Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. Check the NatIpAllocateOption enum for the list of possible values.
↳ nat_ips	array A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.
↳ rules	array<Google\Cloud\Compute\V1\RouterNatRule> A list of rules associated with this NAT.
↳ source_subnetwork_ip_ranges_to_nat	string Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.
↳ subnetworks	array<Google\Cloud\Compute\V1\RouterNatSubnetworkToNat> A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.
↳ tcp_established_idle_timeout_sec	int Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.
↳ tcp_time_wait_timeout_sec	int Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.
↳ tcp_transitory_idle_timeout_sec	int Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.
↳ udp_idle_timeout_sec	int Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

getDrainNatIps

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDrainNatIps

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getEnableDynamicPortAllocation

Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.

Returns
Type	Description
bool

hasEnableDynamicPortAllocation

clearEnableDynamicPortAllocation

setEnableDynamicPortAllocation

Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getEnableEndpointIndependentMapping

Generated from protobuf field optional bool enable_endpoint_independent_mapping = 259441819;

Returns
Type	Description
bool

hasEnableEndpointIndependentMapping

clearEnableEndpointIndependentMapping

setEnableEndpointIndependentMapping

Generated from protobuf field optional bool enable_endpoint_independent_mapping = 259441819;

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getEndpointTypes

List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setEndpointTypes

List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM Check the EndpointTypes enum for the list of possible values.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getIcmpIdleTimeoutSec

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

Returns
Type	Description
int

hasIcmpIdleTimeoutSec

clearIcmpIdleTimeoutSec

setIcmpIdleTimeoutSec

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getLogConfig

Configure logging on this NAT.

Returns
Type	Description
Google\Cloud\Compute\V1\RouterNatLogConfig|null

hasLogConfig

clearLogConfig

setLogConfig

Configure logging on this NAT.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\RouterNatLogConfig

Returns
Type	Description
$this

getMaxPortsPerVm

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

Returns
Type	Description
int

hasMaxPortsPerVm

clearMaxPortsPerVm

setMaxPortsPerVm

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMinPortsPerVm

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

Returns
Type	Description
int

hasMinPortsPerVm

clearMinPortsPerVm

setMinPortsPerVm

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getName

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

Returns
Type	Description
string

hasName

clearName

setName

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNatIpAllocateOption

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Check the NatIpAllocateOption enum for the list of possible values.

Returns
Type	Description
string

hasNatIpAllocateOption

clearNatIpAllocateOption

setNatIpAllocateOption

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Check the NatIpAllocateOption enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNatIps

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setNatIps

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getRules

A list of rules associated with this NAT.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRules

A list of rules associated with this NAT.

Parameter
Name	Description
var	array<Google\Cloud\Compute\V1\RouterNatRule>

Returns
Type	Description
$this

getSourceSubnetworkIpRangesToNat

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

Returns
Type	Description
string

hasSourceSubnetworkIpRangesToNat

clearSourceSubnetworkIpRangesToNat

setSourceSubnetworkIpRangesToNat

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

Check the SourceSubnetworkIpRangesToNat enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSubnetworks

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setSubnetworks

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

Parameter
Name	Description
var	array<Google\Cloud\Compute\V1\RouterNatSubnetworkToNat>

Returns
Type	Description
$this

getTcpEstablishedIdleTimeoutSec

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

Returns
Type	Description
int

hasTcpEstablishedIdleTimeoutSec

clearTcpEstablishedIdleTimeoutSec

setTcpEstablishedIdleTimeoutSec

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTcpTimeWaitTimeoutSec

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

Returns
Type	Description
int

hasTcpTimeWaitTimeoutSec

clearTcpTimeWaitTimeoutSec

setTcpTimeWaitTimeoutSec

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTcpTransitoryIdleTimeoutSec

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

Returns
Type	Description
int

hasTcpTransitoryIdleTimeoutSec

clearTcpTransitoryIdleTimeoutSec

setTcpTransitoryIdleTimeoutSec

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getUdpIdleTimeoutSec

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

Returns
Type	Description
int

hasUdpIdleTimeoutSec

clearUdpIdleTimeoutSec

setUdpIdleTimeoutSec

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

Parameter
Name	Description
var	int

Returns
Type	Description
$this