routes

Creates, updates, deletes, gets or lists a routes resource.

Overview

Name	routes
Type	Resource
Id	google.networkconnectivity.routes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
createTime	string (google-datetime)	Output only. The time the route was created.
description	string	An optional description of the route.
ipCidrRange	string	The destination IP address range.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
location	string	Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
nextHopInterconnectAttachment	object	Immutable. The next-hop VLAN attachment for packets on this route. (id: NextHopInterconnectAttachment)
nextHopRouterApplianceInstance	object	Immutable. The next-hop Router appliance instance for packets on this route. (id: NextHopRouterApplianceInstance)
nextHopSpoke	object	Immutable. The next-hop spoke for packets on this route. (id: NextHopSpoke)
nextHopVpcNetwork	object	Immutable. The destination VPC network for packets on this route. (id: NextHopVpcNetwork)
nextHopVpnTunnel	object	Immutable. The next-hop VPN tunnel for packets on this route. (id: NextHopVPNTunnel)
priority	string (int64)	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.
spoke	string	Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
state	string	Output only. The current lifecycle state of the route. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, ACCEPTING, REJECTING, UPDATING, INACTIVE, OBSOLETE, FAILED)
type	string	Output only. The route's type. Its type is determined by the properties of its IP address range. (ROUTE_TYPE_UNSPECIFIED, VPC_PRIMARY_SUBNET, VPC_SECONDARY_SUBNET, DYNAMIC_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.
updateTime	string (google-datetime)	Output only. The time the route was last updated.

list

Name	Datatype	Description
name	string	Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
createTime	string (google-datetime)	Output only. The time the route was created.
description	string	An optional description of the route.
ipCidrRange	string	The destination IP address range.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
location	string	Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
nextHopInterconnectAttachment	object	Immutable. The next-hop VLAN attachment for packets on this route. (id: NextHopInterconnectAttachment)
nextHopRouterApplianceInstance	object	Immutable. The next-hop Router appliance instance for packets on this route. (id: NextHopRouterApplianceInstance)
nextHopSpoke	object	Immutable. The next-hop spoke for packets on this route. (id: NextHopSpoke)
nextHopVpcNetwork	object	Immutable. The destination VPC network for packets on this route. (id: NextHopVpcNetwork)
nextHopVpnTunnel	object	Immutable. The next-hop VPN tunnel for packets on this route. (id: NextHopVPNTunnel)
priority	string (int64)	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.
spoke	string	Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
state	string	Output only. The current lifecycle state of the route. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, ACCEPTING, REJECTING, UPDATING, INACTIVE, OBSOLETE, FAILED)
type	string	Output only. The route's type. Its type is determined by the properties of its IP address range. (ROUTE_TYPE_UNSPECIFIED, VPC_PRIMARY_SUBNET, VPC_SECONDARY_SUBNET, DYNAMIC_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.
updateTime	string (google-datetime)	Output only. The time the route was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, hubsId, routeTablesId, routesId		Gets details about the specified route.
list	select	projectsId, hubsId, routeTablesId	filter, orderBy, pageSize, pageToken	Lists routes in a given route table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
hubsId	string
projectsId	string
routeTablesId	string
routesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details about the specified route.

SELECT
name,
createTime,
description,
ipCidrRange,
labels,
location,
nextHopInterconnectAttachment,
nextHopRouterApplianceInstance,
nextHopSpoke,
nextHopVpcNetwork,
nextHopVpnTunnel,
priority,
spoke,
state,
type,
uid,
updateTime
FROM google.networkconnectivity.routes
WHERE projectsId = '{{ projectsId }}' -- required
AND hubsId = '{{ hubsId }}' -- required
AND routeTablesId = '{{ routeTablesId }}' -- required
AND routesId = '{{ routesId }}' -- required
;

list

Lists routes in a given route table.

SELECT
name,
createTime,
description,
ipCidrRange,
labels,
location,
nextHopInterconnectAttachment,
nextHopRouterApplianceInstance,
nextHopSpoke,
nextHopVpcNetwork,
nextHopVpnTunnel,
priority,
spoke,
state,
type,
uid,
updateTime
FROM google.networkconnectivity.routes
WHERE projectsId = '{{ projectsId }}' -- required
AND hubsId = '{{ hubsId }}' -- required
AND routeTablesId = '{{ routeTablesId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;