Class Route (1.21.0)

Version 1.21.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

Route(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
as_paths	MutableSequence[google.cloud.compute_v1.types.RouteAsPath] [Output Only] AS path.
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description	str An optional description of this resource. Provide this field when you create the resource. This field is a member of oneof_ _description.
dest_range	str The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format. This field is a member of oneof_ _dest_range.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind	str [Output Only] Type of this resource. Always compute#routes for Route resources. This field is a member of oneof_ _kind.
name	str Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. This field is a member of oneof_ _name.
network	str Fully-qualified URL of the network that this route applies to. This field is a member of oneof_ _network.
next_hop_gateway	str The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway This field is a member of oneof_ _next_hop_gateway.
next_hop_hub	str [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. This field is a member of oneof_ _next_hop_hub.
next_hop_ilb	str The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. This field is a member of oneof_ _next_hop_ilb.
next_hop_instance	str The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ This field is a member of oneof_ _next_hop_instance.
next_hop_ip	str The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. This field is a member of oneof_ _next_hop_ip.
next_hop_network	str The URL of the local network if it should handle matching packets. This field is a member of oneof_ _next_hop_network.
next_hop_peering	str [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. This field is a member of oneof_ _next_hop_peering.
next_hop_vpn_tunnel	str The URL to a VpnTunnel that should handle matching packets. This field is a member of oneof_ _next_hop_vpn_tunnel.
priority	int The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive. This field is a member of oneof_ _priority.
route_status	str [Output only] The status of the route. Check the RouteStatus enum for the list of possible values. This field is a member of oneof_ _route_status.
route_type	str [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route Check the RouteType enum for the list of possible values. This field is a member of oneof_ _route_type.
self_link	str [Output Only] Server-defined fully-qualified URL for this resource. This field is a member of oneof_ _self_link.
tags	MutableSequence[str] A list of instance tags to which this route applies.
warnings	MutableSequence[google.cloud.compute_v1.types.Warnings] [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Classes

RouteStatus

RouteStatus(value)

[Output only] The status of the route.

RouteType

RouteType(value)

[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route