Package com.google.cloud.compute.v1

Interface RouterNatOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RouterNat, RouterNat.Builder
    public interface RouterNatOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasAutoNetworkTier

        boolean hasAutoNetworkTier()
         The network tier to use when automatically reserving IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, PREMIUM tier will be used.
 Check the AutoNetworkTier enum for the list of possible values.
        optional string auto_network_tier = 269770211;
        Returns:
        Whether the autoNetworkTier field is set.

      • getAutoNetworkTier

        String getAutoNetworkTier()
         The network tier to use when automatically reserving IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, PREMIUM tier will be used.
 Check the AutoNetworkTier enum for the list of possible values.
        optional string auto_network_tier = 269770211;
        Returns:
        The autoNetworkTier.

      • getAutoNetworkTierBytes

        com.google.protobuf.ByteString getAutoNetworkTierBytes()
         The network tier to use when automatically reserving IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, PREMIUM tier will be used.
 Check the AutoNetworkTier enum for the list of possible values.
        optional string auto_network_tier = 269770211;
        Returns:
        The bytes for autoNetworkTier.

      • getDrainNatIpsList

        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:
        A list containing the drainNatIps.

      • getDrainNatIpsCount

        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:
        The count of drainNatIps.

      • getDrainNatIps

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The drainNatIps at the given index.

      • getDrainNatIpsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the drainNatIps at the given index.

      • hasEnableDynamicPortAllocation

        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:
        Whether the enableDynamicPortAllocation field is set.

      • getEnableDynamicPortAllocation

        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:
        The enableDynamicPortAllocation.

      • hasEnableEndpointIndependentMapping

        boolean hasEnableEndpointIndependentMapping()
        optional bool enable_endpoint_independent_mapping = 259441819;
        Returns:
        Whether the enableEndpointIndependentMapping field is set.

      • getEnableEndpointIndependentMapping

        boolean getEnableEndpointIndependentMapping()
        optional bool enable_endpoint_independent_mapping = 259441819;
        Returns:
        The enableEndpointIndependentMapping.

      • getEndpointTypesList

        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:
        A list containing the endpointTypes.

      • getEndpointTypesCount

        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:
        The count of endpointTypes.

      • getEndpointTypes

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The endpointTypes at the given index.

      • getEndpointTypesBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the endpointTypes at the given index.

      • hasIcmpIdleTimeoutSec

        boolean hasIcmpIdleTimeoutSec()
         Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
        optional int32 icmp_idle_timeout_sec = 3647562;
        Returns:
        Whether the icmpIdleTimeoutSec field is set.

      • getIcmpIdleTimeoutSec

        int getIcmpIdleTimeoutSec()
         Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
        optional int32 icmp_idle_timeout_sec = 3647562;
        Returns:
        The icmpIdleTimeoutSec.

      • hasLogConfig

        boolean hasLogConfig()
         Configure logging on this NAT.
        optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;
        Returns:
        Whether the logConfig field is set.

      • getLogConfig

        RouterNatLogConfig getLogConfig()
         Configure logging on this NAT.
        optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;
        Returns:
        The logConfig.

      • getLogConfigOrBuilder

        RouterNatLogConfigOrBuilder getLogConfigOrBuilder()
         Configure logging on this NAT.
        optional .google.cloud.compute.v1.RouterNatLogConfig log_config = 351299741;

      • hasMaxPortsPerVm

        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:
        Whether the maxPortsPerVm field is set.

      • getMaxPortsPerVm

        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:
        The maxPortsPerVm.

      • hasMinPortsPerVm

        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:
        Whether the minPortsPerVm field is set.

      • getMinPortsPerVm

        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:
        The minPortsPerVm.

      • hasName

        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:
        Whether the name field is set.

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • hasNatIpAllocateOption

        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:
        Whether the natIpAllocateOption field is set.

      • getNatIpAllocateOption

        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:
        The natIpAllocateOption.

      • getNatIpAllocateOptionBytes

        com.google.protobuf.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:
        The bytes for natIpAllocateOption.

      • getNatIpsList

        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:
        A list containing the natIps.

      • getNatIpsCount

        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:
        The count of natIps.

      • getNatIps

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The natIps at the given index.

      • getNatIpsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the natIps at the given index.

      • getRulesList

        List<RouterNatRule> getRulesList()
         A list of rules associated with this NAT.
        repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

      • getRules

        RouterNatRule getRules​(int index)
         A list of rules associated with this NAT.
        repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

      • getRulesCount

        int getRulesCount()
         A list of rules associated with this NAT.
        repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

      • getRulesOrBuilderList

        List<? extends RouterNatRuleOrBuilder> getRulesOrBuilderList()
         A list of rules associated with this NAT.
        repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

      • getRulesOrBuilder

        RouterNatRuleOrBuilder getRulesOrBuilder​(int index)
         A list of rules associated with this NAT.
        repeated .google.cloud.compute.v1.RouterNatRule rules = 108873975;

      • hasSourceSubnetworkIpRangesToNat

        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 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:
        Whether the sourceSubnetworkIpRangesToNat field is set.

      • getSourceSubnetworkIpRangesToNat

        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 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:
        The sourceSubnetworkIpRangesToNat.

      • getSourceSubnetworkIpRangesToNatBytes

        com.google.protobuf.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 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:
        The bytes for sourceSubnetworkIpRangesToNat.

      • getSubnetworksList

        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;

      • getSubnetworks

        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;

      • getSubnetworksCount

        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;

      • getSubnetworksOrBuilderList

        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;

      • getSubnetworksOrBuilder

        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;

      • hasTcpEstablishedIdleTimeoutSec

        boolean hasTcpEstablishedIdleTimeoutSec()
         Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.
        optional int32 tcp_established_idle_timeout_sec = 223098349;
        Returns:
        Whether the tcpEstablishedIdleTimeoutSec field is set.

      • getTcpEstablishedIdleTimeoutSec

        int getTcpEstablishedIdleTimeoutSec()
         Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.
        optional int32 tcp_established_idle_timeout_sec = 223098349;
        Returns:
        The tcpEstablishedIdleTimeoutSec.

      • hasTcpTimeWaitTimeoutSec

        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:
        Whether the tcpTimeWaitTimeoutSec field is set.

      • getTcpTimeWaitTimeoutSec

        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:
        The tcpTimeWaitTimeoutSec.

      • hasTcpTransitoryIdleTimeoutSec

        boolean hasTcpTransitoryIdleTimeoutSec()
         Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.
        optional int32 tcp_transitory_idle_timeout_sec = 205028774;
        Returns:
        Whether the tcpTransitoryIdleTimeoutSec field is set.

      • getTcpTransitoryIdleTimeoutSec

        int getTcpTransitoryIdleTimeoutSec()
         Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.
        optional int32 tcp_transitory_idle_timeout_sec = 205028774;
        Returns:
        The tcpTransitoryIdleTimeoutSec.

      • hasUdpIdleTimeoutSec

        boolean hasUdpIdleTimeoutSec()
         Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
        optional int32 udp_idle_timeout_sec = 64919878;
        Returns:
        Whether the udpIdleTimeoutSec field is set.

      • getUdpIdleTimeoutSec

        int getUdpIdleTimeoutSec()
         Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
        optional int32 udp_idle_timeout_sec = 64919878;
        Returns:
        The udpIdleTimeoutSec.