Interface RouterNatOrBuilder (1.23.0)

Version 1.23.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface RouterNatOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDrainNatIps(int index)

public abstract String getDrainNatIps(int index)

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.

repeated string drain_nat_ips = 504078535;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The drainNatIps at the given index.

getDrainNatIpsBytes(int index)

public abstract ByteString getDrainNatIpsBytes(int index)

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.

repeated string drain_nat_ips = 504078535;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the drainNatIps at the given index.

getDrainNatIpsCount()

public abstract int getDrainNatIpsCount()

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.

repeated string drain_nat_ips = 504078535;

Returns
Type	Description
int	The count of drainNatIps.

getDrainNatIpsList()

public abstract List<String> getDrainNatIpsList()

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.

repeated string drain_nat_ips = 504078535;

Returns
Type	Description
List<String>	A list containing the drainNatIps.

getEnableDynamicPortAllocation()

public abstract boolean 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.

optional bool enable_dynamic_port_allocation = 532106402;

Returns
Type	Description
boolean	The enableDynamicPortAllocation.

getEnableEndpointIndependentMapping()

public abstract boolean getEnableEndpointIndependentMapping()

optional bool enable_endpoint_independent_mapping = 259441819;

Returns
Type	Description
boolean	The enableEndpointIndependentMapping.

getEndpointTypes(int index)

public abstract String getEndpointTypes(int index)

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.

repeated string endpoint_types = 502633807;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The endpointTypes at the given index.

getEndpointTypesBytes(int index)

public abstract ByteString getEndpointTypesBytes(int index)

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.

repeated string endpoint_types = 502633807;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the endpointTypes at the given index.

getEndpointTypesCount()

public abstract int getEndpointTypesCount()

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.

repeated string endpoint_types = 502633807;

Returns
Type	Description
int	The count of endpointTypes.

getEndpointTypesList()

public abstract List<String> getEndpointTypesList()

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.

repeated string endpoint_types = 502633807;

Returns
Type	Description
List<String>	A list containing the endpointTypes.

getIcmpIdleTimeoutSec()

public abstract int getIcmpIdleTimeoutSec()

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

optional int32 icmp_idle_timeout_sec = 3647562;

Returns
Type	Description
int	The icmpIdleTimeoutSec.

getLogConfig()

public abstract RouterNatLogConfig getLogConfig()

Configure logging on this NAT.

optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;

Returns
Type	Description
RouterNatLogConfig	The logConfig.

getLogConfigOrBuilder()

public abstract RouterNatLogConfigOrBuilder getLogConfigOrBuilder()

Configure logging on this NAT.

optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;

Returns
Type	Description
RouterNatLogConfigOrBuilder

getMaxPortsPerVm()

public abstract int 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.

optional int32 max_ports_per_vm = 250062049;

Returns
Type	Description
int	The maxPortsPerVm.

getMinPortsPerVm()

public abstract int 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.

optional int32 min_ports_per_vm = 186193587;

Returns
Type	Description
int	The minPortsPerVm.

getName()

public abstract String getName()

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

optional string name = 3373707;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type	Description
ByteString	The bytes for name.

getNatIpAllocateOption()

public abstract String 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.

optional string nat_ip_allocate_option = 429726845;

Returns
Type	Description
String	The natIpAllocateOption.

getNatIpAllocateOptionBytes()

public abstract ByteString getNatIpAllocateOptionBytes()

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.

optional string nat_ip_allocate_option = 429726845;

Returns
Type	Description
ByteString	The bytes for natIpAllocateOption.

getNatIps(int index)

public abstract String getNatIps(int index)

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.

repeated string nat_ips = 117635086;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The natIps at the given index.

getNatIpsBytes(int index)

public abstract ByteString getNatIpsBytes(int index)

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.

repeated string nat_ips = 117635086;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the natIps at the given index.

getNatIpsCount()

public abstract int getNatIpsCount()

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.

repeated string nat_ips = 117635086;

Returns
Type	Description
int	The count of natIps.

getNatIpsList()

public abstract List<String> getNatIpsList()

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.

repeated string nat_ips = 117635086;

Returns
Type	Description
List<String>	A list containing the natIps.

getRules(int index)

public abstract RouterNatRule getRules(int index)

A list of rules associated with this NAT.

repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterNatRule

getRulesCount()

public abstract int getRulesCount()

A list of rules associated with this NAT.

repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

Returns
Type	Description
int

getRulesList()

public abstract List<RouterNatRule> getRulesList()

A list of rules associated with this NAT.

repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

Returns
Type	Description
List<RouterNatRule>

getRulesOrBuilder(int index)

public abstract RouterNatRuleOrBuilder getRulesOrBuilder(int index)

A list of rules associated with this NAT.

repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterNatRuleOrBuilder

getRulesOrBuilderList()

public abstract List<? extends RouterNatRuleOrBuilder> getRulesOrBuilderList()

A list of rules associated with this NAT.

repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.RouterNatRuleOrBuilder>

getSourceSubnetworkIpRangesToNat()

public abstract String 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.

optional string source_subnetwork_ip_ranges_to_nat = 252213211;

Returns
Type	Description
String	The sourceSubnetworkIpRangesToNat.

getSourceSubnetworkIpRangesToNatBytes()

public abstract ByteString getSourceSubnetworkIpRangesToNatBytes()

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.

optional string source_subnetwork_ip_ranges_to_nat = 252213211;

Returns
Type	Description
ByteString	The bytes for sourceSubnetworkIpRangesToNat.

getSubnetworks(int index)

public abstract RouterNatSubnetworkToNat getSubnetworks(int index)

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.

repeated .google.cloud.compute.v1.RouterNatSubnetworkToNat subnetworks = 415853125;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterNatSubnetworkToNat

getSubnetworksCount()

public abstract int getSubnetworksCount()

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.

repeated .google.cloud.compute.v1.RouterNatSubnetworkToNat subnetworks = 415853125;

Returns
Type	Description
int

getSubnetworksList()

public abstract List<RouterNatSubnetworkToNat> getSubnetworksList()

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.

repeated .google.cloud.compute.v1.RouterNatSubnetworkToNat subnetworks = 415853125;

Returns
Type	Description
List<RouterNatSubnetworkToNat>

getSubnetworksOrBuilder(int index)

public abstract RouterNatSubnetworkToNatOrBuilder getSubnetworksOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.RouterNatSubnetworkToNat subnetworks = 415853125;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterNatSubnetworkToNatOrBuilder

getSubnetworksOrBuilderList()

public abstract List<? extends RouterNatSubnetworkToNatOrBuilder> getSubnetworksOrBuilderList()

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.

repeated .google.cloud.compute.v1.RouterNatSubnetworkToNat subnetworks = 415853125;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.RouterNatSubnetworkToNatOrBuilder>

getTcpEstablishedIdleTimeoutSec()

public abstract int getTcpEstablishedIdleTimeoutSec()

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

optional int32 tcp_established_idle_timeout_sec = 223098349;

Returns
Type	Description
int	The tcpEstablishedIdleTimeoutSec.

getTcpTimeWaitTimeoutSec()

public abstract int getTcpTimeWaitTimeoutSec()

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

optional int32 tcp_time_wait_timeout_sec = 513596925;

Returns
Type	Description
int	The tcpTimeWaitTimeoutSec.

getTcpTransitoryIdleTimeoutSec()

public abstract int getTcpTransitoryIdleTimeoutSec()

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

optional int32 tcp_transitory_idle_timeout_sec = 205028774;

Returns
Type	Description
int	The tcpTransitoryIdleTimeoutSec.

getUdpIdleTimeoutSec()

public abstract int getUdpIdleTimeoutSec()

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

optional int32 udp_idle_timeout_sec = 64919878;

Returns
Type	Description
int	The udpIdleTimeoutSec.

hasEnableDynamicPortAllocation()

public abstract boolean hasEnableDynamicPortAllocation()

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.

optional bool enable_dynamic_port_allocation = 532106402;

Returns
Type	Description
boolean	Whether the enableDynamicPortAllocation field is set.

hasEnableEndpointIndependentMapping()

public abstract boolean hasEnableEndpointIndependentMapping()

optional bool enable_endpoint_independent_mapping = 259441819;

Returns
Type	Description
boolean	Whether the enableEndpointIndependentMapping field is set.

hasIcmpIdleTimeoutSec()

public abstract boolean hasIcmpIdleTimeoutSec()

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

optional int32 icmp_idle_timeout_sec = 3647562;

Returns
Type	Description
boolean	Whether the icmpIdleTimeoutSec field is set.

hasLogConfig()

public abstract boolean hasLogConfig()

Configure logging on this NAT.

optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;

Returns
Type	Description
boolean	Whether the logConfig field is set.

hasMaxPortsPerVm()

public abstract boolean hasMaxPortsPerVm()

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.

optional int32 max_ports_per_vm = 250062049;

Returns
Type	Description
boolean	Whether the maxPortsPerVm field is set.

hasMinPortsPerVm()

public abstract boolean hasMinPortsPerVm()

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.

optional int32 min_ports_per_vm = 186193587;

Returns
Type	Description
boolean	Whether the minPortsPerVm field is set.

hasName()

public abstract boolean hasName()

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

optional string name = 3373707;

Returns
Type	Description
boolean	Whether the name field is set.

hasNatIpAllocateOption()

public abstract boolean hasNatIpAllocateOption()

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.

optional string nat_ip_allocate_option = 429726845;

Returns
Type	Description
boolean	Whether the natIpAllocateOption field is set.

hasSourceSubnetworkIpRangesToNat()

public abstract boolean hasSourceSubnetworkIpRangesToNat()

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.

optional string source_subnetwork_ip_ranges_to_nat = 252213211;

Returns
Type	Description
boolean	Whether the sourceSubnetworkIpRangesToNat field is set.

hasTcpEstablishedIdleTimeoutSec()

public abstract boolean hasTcpEstablishedIdleTimeoutSec()

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

optional int32 tcp_established_idle_timeout_sec = 223098349;

Returns
Type	Description
boolean	Whether the tcpEstablishedIdleTimeoutSec field is set.

hasTcpTimeWaitTimeoutSec()

public abstract boolean hasTcpTimeWaitTimeoutSec()

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

optional int32 tcp_time_wait_timeout_sec = 513596925;

Returns
Type	Description
boolean	Whether the tcpTimeWaitTimeoutSec field is set.

hasTcpTransitoryIdleTimeoutSec()

public abstract boolean hasTcpTransitoryIdleTimeoutSec()

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

optional int32 tcp_transitory_idle_timeout_sec = 205028774;

Returns
Type	Description
boolean	Whether the tcpTransitoryIdleTimeoutSec field is set.

hasUdpIdleTimeoutSec()

public abstract boolean hasUdpIdleTimeoutSec()

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

optional int32 udp_idle_timeout_sec = 64919878;

Returns
Type	Description
boolean	Whether the udpIdleTimeoutSec field is set.