Compute Engine v1 API - Class Route (3.2.0)

public sealed class Route : IMessage<Route>, IEquatable<Route>, IDeepCloneable<Route>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Route.

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.

Inheritance

object > Route

Implements

IMessage Route, IEquatable Route, IDeepCloneable Route, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Route()

public Route()

Route(Route)

public Route(Route other)

Parameter
Name	Description
`other`	`Route`

Properties

AsPaths

public RepeatedField<RouteAsPath> AsPaths { get; }

[Output Only] AS path.

Property Value
Type	Description
`RepeatedFieldRouteAsPath`

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

An optional description of this resource. Provide this field when you create the resource.

Property Value
Type	Description
`string`

DestRange

public string DestRange { get; set; }

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.

Property Value
Type	Description
`string`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasDestRange

public bool HasDestRange { get; }

Gets whether the "dest_range" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasNetwork

public bool HasNetwork { get; }

Gets whether the "network" field is set

Property Value
Type	Description
`bool`

HasNextHopGateway

public bool HasNextHopGateway { get; }

Gets whether the "next_hop_gateway" field is set

Property Value
Type	Description
`bool`

HasNextHopHub

public bool HasNextHopHub { get; }

Gets whether the "next_hop_hub" field is set

Property Value
Type	Description
`bool`

HasNextHopIlb

public bool HasNextHopIlb { get; }

Gets whether the "next_hop_ilb" field is set

Property Value
Type	Description
`bool`

HasNextHopInstance

public bool HasNextHopInstance { get; }

Gets whether the "next_hop_instance" field is set

Property Value
Type	Description
`bool`

HasNextHopInterRegionCost

public bool HasNextHopInterRegionCost { get; }

Gets whether the "next_hop_inter_region_cost" field is set

Property Value
Type	Description
`bool`

HasNextHopIp

public bool HasNextHopIp { get; }

Gets whether the "next_hop_ip" field is set

Property Value
Type	Description
`bool`

HasNextHopMed

public bool HasNextHopMed { get; }

Gets whether the "next_hop_med" field is set

Property Value
Type	Description
`bool`

HasNextHopNetwork

public bool HasNextHopNetwork { get; }

Gets whether the "next_hop_network" field is set

Property Value
Type	Description
`bool`

HasNextHopOrigin

public bool HasNextHopOrigin { get; }

Gets whether the "next_hop_origin" field is set

Property Value
Type	Description
`bool`

HasNextHopPeering

public bool HasNextHopPeering { get; }

Gets whether the "next_hop_peering" field is set

Property Value
Type	Description
`bool`

HasNextHopVpnTunnel

public bool HasNextHopVpnTunnel { get; }

Gets whether the "next_hop_vpn_tunnel" field is set

Property Value
Type	Description
`bool`

HasPriority

public bool HasPriority { get; }

Gets whether the "priority" field is set

Property Value
Type	Description
`bool`

HasRouteStatus

public bool HasRouteStatus { get; }

Gets whether the "route_status" field is set

Property Value
Type	Description
`bool`

HasRouteType

public bool HasRouteType { get; }

Gets whether the "route_type" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
Type	Description
`ulong`

Kind

public string Kind { get; set; }

[Output Only] Type of this resource. Always compute#routes for Route resources.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`string`

Network

public string Network { get; set; }

Fully-qualified URL of the network that this route applies to.

Property Value
Type	Description
`string`

NextHopGateway

public string NextHopGateway { get; set; }

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

Property Value
Type	Description
`string`

NextHopHub

public string NextHopHub { get; set; }

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

Property Value
Type	Description
`string`

NextHopIlb

public string NextHopIlb { get; set; }

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.

Property Value
Type	Description
`string`

NextHopInstance

public string NextHopInstance { get; set; }

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/

Property Value
Type	Description
`string`

NextHopInterRegionCost

public uint NextHopInterRegionCost { get; set; }

[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.

Property Value
Type	Description
`uint`

NextHopIp

public string NextHopIp { get; set; }

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.

Property Value
Type	Description
`string`

NextHopMed

public uint NextHopMed { get; set; }

[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

Property Value
Type	Description
`uint`

NextHopNetwork

public string NextHopNetwork { get; set; }

The URL of the local network if it should handle matching packets.

Property Value
Type	Description
`string`

NextHopOrigin

public string NextHopOrigin { get; set; }

[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

Property Value
Type	Description
`string`

NextHopPeering

public string NextHopPeering { get; set; }

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

Property Value
Type	Description
`string`

NextHopVpnTunnel

public string NextHopVpnTunnel { get; set; }

The URL to a VpnTunnel that should handle matching packets.

Property Value
Type	Description
`string`

Priority

public uint Priority { get; set; }

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.

Property Value
Type	Description
`uint`

RouteStatus

public string RouteStatus { get; set; }

[Output only] The status of the route. Check the RouteStatus enum for the list of possible values.

Property Value
Type	Description
`string`

RouteType

public string RouteType { get; set; }

[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.

Property Value
Type	Description
`string`

SelfLink

public string SelfLink { get; set; }

[Output Only] Server-defined fully-qualified URL for this resource.

Property Value
Type	Description
`string`

Warnings

public RepeatedField<Warnings> Warnings { get; }

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Property Value
Type	Description
`RepeatedFieldWarnings`