Skip to content

compute.v1beta1.computeRouterNAT

Index

Fields

fn new

new(name)

new returns an instance of ComputeRouterNAT

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withDrainNatIps

withDrainNatIps(drainNatIps)

fn spec.withDrainNatIpsMixin

withDrainNatIpsMixin(drainNatIps)

Note: This function appends passed data to existing values

fn spec.withEnableDynamicPortAllocation

withEnableDynamicPortAllocation(enableDynamicPortAllocation)

"Enable Dynamic Port Allocation.\nIf minPortsPerVm is set, minPortsPerVm must be set to a power of two greater than or equal to 32.\nIf minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.\nIf maxPortsPerVm is set, maxPortsPerVm must be set to a power of two greater than minPortsPerVm.\nIf maxPortsPerVm is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.\n\nMutually exclusive with enableEndpointIndependentMapping."

fn spec.withEnableEndpointIndependentMapping

withEnableEndpointIndependentMapping(enableEndpointIndependentMapping)

"Specifies if endpoint independent mapping is enabled. This is enabled by default. For more information\nsee the official documentation."

fn spec.withIcmpIdleTimeoutSec

withIcmpIdleTimeoutSec(icmpIdleTimeoutSec)

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

fn spec.withMaxPortsPerVm

withMaxPortsPerVm(maxPortsPerVm)

"Maximum number of ports allocated to a VM from this NAT.\nThis field can only be set when enableDynamicPortAllocation is enabled."

fn spec.withMinPortsPerVm

withMinPortsPerVm(minPortsPerVm)

"Minimum number of ports allocated to a VM from this NAT."

fn spec.withNatIpAllocateOption

withNatIpAllocateOption(natIpAllocateOption)

"How external IPs should be allocated for this NAT. Valid values are\n'AUTO_ONLY' for only allowing NAT IPs allocated by Google Cloud\nPlatform, or 'MANUAL_ONLY' for only user-allocated NAT IP addresses. Possible values: [\"MANUAL_ONLY\", \"AUTO_ONLY\"]."

fn spec.withNatIps

withNatIps(natIps)

fn spec.withNatIpsMixin

withNatIpsMixin(natIps)

Note: This function appends passed data to existing values

fn spec.withRegion

withRegion(region)

"Immutable. Region where the router and NAT reside."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

fn spec.withRules

withRules(rules)

"A list of rules associated with this NAT."

fn spec.withRulesMixin

withRulesMixin(rules)

"A list of rules associated with this NAT."

Note: This function appends passed data to existing values

fn spec.withSourceSubnetworkIpRangesToNat

withSourceSubnetworkIpRangesToNat(sourceSubnetworkIpRangesToNat)

"How NAT should be configured per Subnetwork.\nIf 'ALL_SUBNETWORKS_ALL_IP_RANGES', all of the\nIP ranges in every Subnetwork are allowed to Nat.\nIf 'ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES', all of the primary IP\nranges in every Subnetwork are allowed to Nat.\n'LIST_OF_SUBNETWORKS': A list of Subnetworks are allowed to Nat\n(specified in the field subnetwork below). Note that if this field\ncontains ALL_SUBNETWORKS_ALL_IP_RANGES or\nALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any\nother RouterNat section in any Router for this network in this region. Possible values: [\"ALL_SUBNETWORKS_ALL_IP_RANGES\", \"ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES\", \"LIST_OF_SUBNETWORKS\"]."

fn spec.withSubnetwork

withSubnetwork(subnetwork)

"One or more subnetwork NAT configurations. Only used if\n'source_subnetwork_ip_ranges_to_nat' is set to 'LIST_OF_SUBNETWORKS'."

fn spec.withSubnetworkMixin

withSubnetworkMixin(subnetwork)

"One or more subnetwork NAT configurations. Only used if\n'source_subnetwork_ip_ranges_to_nat' is set to 'LIST_OF_SUBNETWORKS'."

Note: This function appends passed data to existing values

fn spec.withTcpEstablishedIdleTimeoutSec

withTcpEstablishedIdleTimeoutSec(tcpEstablishedIdleTimeoutSec)

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

fn spec.withTcpTimeWaitTimeoutSec

withTcpTimeWaitTimeoutSec(tcpTimeWaitTimeoutSec)

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

fn spec.withTcpTransitoryIdleTimeoutSec

withTcpTransitoryIdleTimeoutSec(tcpTransitoryIdleTimeoutSec)

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

fn spec.withUdpIdleTimeoutSec

withUdpIdleTimeoutSec(udpIdleTimeoutSec)

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

obj spec.drainNatIps

fn spec.drainNatIps.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeAddress resource."

fn spec.drainNatIps.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.drainNatIps.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.logConfig

"Configuration for logging on NAT."

fn spec.logConfig.withEnable

withEnable(enable)

"Indicates whether or not to export logs."

fn spec.logConfig.withFilter

withFilter(filter)

"Specifies the desired filtering of logs on this NAT. Possible values: [\"ERRORS_ONLY\", \"TRANSLATIONS_ONLY\", \"ALL\"]."

obj spec.natIps

fn spec.natIps.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeAddress resource."

fn spec.natIps.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.natIps.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.routerRef

"The Cloud Router in which this NAT will be configured."

fn spec.routerRef.withExternal

withExternal(external)

"Allowed value: The name field of a ComputeRouter resource."

fn spec.routerRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.routerRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.rules

"A list of rules associated with this NAT."

fn spec.rules.withDescription

withDescription(description)

"An optional description of this rule."

fn spec.rules.withMatch

withMatch(match)

"CEL expression that specifies the match condition that egress traffic from a VM is evaluated against.\nIf it evaluates to true, the corresponding action is enforced.\n\nThe following examples are valid match expressions for public NAT:\n\n\"inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')\"\n\n\"destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'\"\n\nThe following example is a valid match expression for private NAT:\n\n\"nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'\"."

fn spec.rules.withRuleNumber

withRuleNumber(ruleNumber)

"An integer uniquely identifying a rule in the list.\nThe rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT."

obj spec.rules.action

"The action to be enforced for traffic that matches this rule."

fn spec.rules.action.withSourceNatActiveIpsRefs

withSourceNatActiveIpsRefs(sourceNatActiveIpsRefs)

fn spec.rules.action.withSourceNatActiveIpsRefsMixin

withSourceNatActiveIpsRefsMixin(sourceNatActiveIpsRefs)

Note: This function appends passed data to existing values

fn spec.rules.action.withSourceNatDrainIpsRefs

withSourceNatDrainIpsRefs(sourceNatDrainIpsRefs)

fn spec.rules.action.withSourceNatDrainIpsRefsMixin

withSourceNatDrainIpsRefsMixin(sourceNatDrainIpsRefs)

Note: This function appends passed data to existing values

obj spec.rules.action.sourceNatActiveIpsRefs

fn spec.rules.action.sourceNatActiveIpsRefs.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeAddress resource."

fn spec.rules.action.sourceNatActiveIpsRefs.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.rules.action.sourceNatActiveIpsRefs.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.rules.action.sourceNatDrainIpsRefs

fn spec.rules.action.sourceNatDrainIpsRefs.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeAddress resource."

fn spec.rules.action.sourceNatDrainIpsRefs.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.rules.action.sourceNatDrainIpsRefs.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.subnetwork

"One or more subnetwork NAT configurations. Only used if\n'source_subnetwork_ip_ranges_to_nat' is set to 'LIST_OF_SUBNETWORKS'."

fn spec.subnetwork.withSecondaryIpRangeNames

withSecondaryIpRangeNames(secondaryIpRangeNames)

"List of the secondary ranges of the subnetwork that are allowed\nto use NAT. This can be populated only if\n'LIST_OF_SECONDARY_IP_RANGES' is one of the values in\nsourceIpRangesToNat."

fn spec.subnetwork.withSecondaryIpRangeNamesMixin

withSecondaryIpRangeNamesMixin(secondaryIpRangeNames)

"List of the secondary ranges of the subnetwork that are allowed\nto use NAT. This can be populated only if\n'LIST_OF_SECONDARY_IP_RANGES' is one of the values in\nsourceIpRangesToNat."

Note: This function appends passed data to existing values

fn spec.subnetwork.withSourceIpRangesToNat

withSourceIpRangesToNat(sourceIpRangesToNat)

"List of options for which source IPs in the subnetwork\nshould have NAT enabled. Supported values include:\n'ALL_IP_RANGES', 'LIST_OF_SECONDARY_IP_RANGES',\n'PRIMARY_IP_RANGE'."

fn spec.subnetwork.withSourceIpRangesToNatMixin

withSourceIpRangesToNatMixin(sourceIpRangesToNat)

"List of options for which source IPs in the subnetwork\nshould have NAT enabled. Supported values include:\n'ALL_IP_RANGES', 'LIST_OF_SECONDARY_IP_RANGES',\n'PRIMARY_IP_RANGE'."

Note: This function appends passed data to existing values

obj spec.subnetwork.subnetworkRef

"The subnetwork to NAT."

fn spec.subnetwork.subnetworkRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a ComputeSubnetwork resource."

fn spec.subnetwork.subnetworkRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.subnetwork.subnetworkRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"