GoogleComputeRoute class final

Factory wrapper for google_compute_route.

Represents a Route resource.

A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine's routing table for a single best matching route.

Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route -- either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine's routing table will be dropped.

A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, nextHopVpnTunnel, or nextHopIlb.

A Route resource must have exactly one ComputeRouteNextHop: ComputeRouteGatewayNextHop, ComputeRouteIpNextHop, ComputeRouteInstanceNextHop, ComputeRouteIlbNextHop, or ComputeRouteVpnTunnelNextHop.

When using ComputeRouteInstanceNextHop, set nextHopInstanceZone on the factory when the instance is specified by name only (not a full self-link).

Inheritance

Object
Resource
GoogleComputeRoute

Constructors

GoogleComputeRoute(String localName, {required TfArg<String> name, required RefTo<GoogleComputeNetwork> network, required TfArg<String> destRange, required ComputeRouteNextHop nextHop, TfArg<String>? description, TfArg<num>? priority, TfArg<String>? nextHopInstanceZone, TfArg<List<String>>? tags, ComputeRouteParams? params, TfArg<String>? project, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
asPaths → TfRef<List<Map<String, Object?>>>: Reference to as_paths attribute.
no setter
creationTimestamp → TfRef<String>: Reference to creation_timestamp attribute.
no setter
defaultProvider → String: The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>: Reference to deletion_policy attribute.
no setter
dependsOn → List<TfAddressed>?: Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. dependsOn: [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
description → TfRef<String>: Reference to description attribute.
no setter
destRange → TfRef<String>: Reference to dest_range attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
name → TfRef<String>: Reference to name attribute.
no setter
network → TfRef<String>: Reference to network attribute.
no setter
nextHopGateway → TfRef<String>: Reference to next_hop_gateway attribute.
no setter
nextHopHub → TfRef<String>: Reference to next_hop_hub attribute.
no setter
nextHopIlb → TfRef<String>: Reference to next_hop_ilb attribute.
no setter
nextHopInstance → TfRef<String>: Reference to next_hop_instance attribute.
no setter
nextHopInstanceZone → TfRef<String>: Reference to next_hop_instance_zone attribute.
no setter
nextHopInterRegionCost → TfRef<String>: Reference to next_hop_inter_region_cost attribute.
no setter
nextHopIp → TfRef<String>: Reference to next_hop_ip attribute.
no setter
nextHopMed → TfRef<String>: Reference to next_hop_med attribute.
no setter
nextHopNetwork → TfRef<String>: Reference to next_hop_network attribute.
no setter
nextHopOrigin → TfRef<String>: Reference to next_hop_origin attribute.
no setter
nextHopPeering → TfRef<String>: Reference to next_hop_peering attribute.
no setter
nextHopVpnTunnel → TfRef<String>: Reference to next_hop_vpn_tunnel attribute.
no setter
priority → TfRef<num>: Reference to priority attribute.
no setter
project → TfRef<String>: Reference to project attribute.
no setter
provider → StackProvider?: Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. the aliased GoogleProvider(alias: 'eu') the Stack registered with addProvider.
finalinherited
ref → RefTo<GoogleComputeRoute>: A reference to this resource, for arguments typed RefTo<GoogleComputeRoute>.
no setter
routeStatus → TfRef<String>: Reference to route_status attribute.
no setter
routeType → TfRef<String>: Reference to route_type attribute.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selfLink → TfRef<String>: Reference to self_link attribute.
no setter
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setteroverride
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
tags → TfRef<List<String>>: Reference to tags attribute.
no setter
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
timeouts → TfTimeouts?: Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
warnings → TfRef<List<Map<String, Object?>>>: Reference to warnings attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String