REST Resource: projects.locations.global.hubs.routeTables.routes

Resource: Route

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "ipCidrRange": string,
  "type": enum (RouteType),
  "nextHopVpcNetwork": {
    object (NextHopVpcNetwork)
  },
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "uid": string,
  "state": enum (State),
  "spoke": string,
  "location": string,
  "priority": string,
  "nextHopVpnTunnel": {
    object (NextHopVPNTunnel)
  },
  "nextHopRouterApplianceInstance": {
    object (NextHopRouterApplianceInstance)
  },
  "nextHopInterconnectAttachment": {
    object (NextHopInterconnectAttachment)
  }
}
Fields
name

string

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{projectNumber}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
createTime

string (Timestamp format)

Output only. The time the route was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time the route was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
ipCidrRange

string

The destination IP address range.
type

enum (RouteType)

Output only. The route's type. Its type is determined by the properties of its IP address range.
nextHopVpcNetwork

object (NextHopVpcNetwork)

Immutable. The destination VPC network for packets on this route.
labels

map (key: string, value: string)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

An optional description of the route.
uid

string

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.
state

enum (State)

Output only. The current lifecycle state of the route.
spoke

string

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
location

string

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
priority

string (int64 format)

Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
nextHopVpnTunnel

object (NextHopVPNTunnel)

Immutable. The next-hop VPN tunnel for packets on this route.
nextHopRouterApplianceInstance

object (NextHopRouterApplianceInstance)

Immutable. The next-hop Router appliance instance for packets on this route.
nextHopInterconnectAttachment

object (NextHopInterconnectAttachment)

Immutable. The next-hop VLAN attachment for packets on this route.

RouteType

The route's type

Enums
ROUTE_TYPE_UNSPECIFIED No route type information specified
VPC_PRIMARY_SUBNET The route leads to a destination within the primary address range of the VPC network's subnet.
VPC_SECONDARY_SUBNET The route leads to a destination within the secondary address range of the VPC network's subnet.
DYNAMIC_ROUTE The route leads to a destination in a dynamic route. Dynamic routes are derived from Border Gateway Protocol (BGP) advertisements received from an NCC hybrid spoke.

NextHopVpcNetwork

JSON representation 
{
  "uri": string
}
Fields
uri

string

The URI of the VPC network resource

NextHopVPNTunnel

A route next hop that leads to a VPN tunnel resource.

JSON representation 
{
  "uri": string,
  "vpcNetwork": string,
  "siteToSiteDataTransfer": boolean
}
Fields
uri

string

The URI of the VPN tunnel resource.
vpcNetwork

string

The VPC network where this VPN tunnel is located.
siteToSiteDataTransfer

boolean

Indicates whether site-to-site data transfer is allowed for this VPN tunnel resource. Data transfer is available only in supported locations.

NextHopRouterApplianceInstance

A route next hop that leads to a Router appliance instance.

JSON representation 
{
  "uri": string,
  "vpcNetwork": string,
  "siteToSiteDataTransfer": boolean
}
Fields
uri

string

The URI of the Router appliance instance.
vpcNetwork

string

The VPC network where this VM is located.
siteToSiteDataTransfer

boolean

Indicates whether site-to-site data transfer is allowed for this Router appliance instance resource. Data transfer is available only in supported locations.

NextHopInterconnectAttachment

A route next hop that leads to an interconnect attachment resource.

JSON representation 
{
  "uri": string,
  "vpcNetwork": string,
  "siteToSiteDataTransfer": boolean
}
Fields
uri

string

The URI of the interconnect attachment resource.
vpcNetwork

string

The VPC network where this interconnect attachment is located.
siteToSiteDataTransfer

boolean

Indicates whether site-to-site data transfer is allowed for this interconnect attachment resource. Data transfer is available only in supported locations.

Methods

get

 Gets details about the specified route.

list

 Lists routes in a given route table.