Route

import type { Route } from "https://googleapis.deno.dev/v1/compute:v1.ts";

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.

interface Route {

asPaths?: RouteAsPath[];

creationTimestamp?: string;

description?: string;

destRange?: string;

id?: bigint;

kind?: string;

name?: string;

network?: string;

nextHopGateway?: string;

nextHopHub?: string;

nextHopIlb?: string;

nextHopInstance?: string;

nextHopInterRegionCost?: number;

nextHopIp?: string;

nextHopMed?: number;

nextHopNetwork?: string;

nextHopOrigin?: "EGP" | "IGP" | "INCOMPLETE";

nextHopPeering?: string;

nextHopVpnTunnel?: string;

params?: RouteParams;

priority?: number;

routeStatus?:

| "ACTIVE"

| "DROPPED"

| "INACTIVE"

| "PENDING";

routeType?:

| "BGP"

| "STATIC"

| "SUBNET"

| "TRANSIT";

selfLink?: string;

tags?: string[];

warnings?: {

code?:

| "CLEANUP_FAILED"

| "DEPRECATED_RESOURCE_USED"

| "DEPRECATED_TYPE_USED"

| "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"

| "EXPERIMENTAL_TYPE_USED"

| "EXTERNAL_API_WARNING"

| "FIELD_VALUE_OVERRIDEN"

| "INJECTED_KERNELS_DEPRECATED"

| "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB"

| "LARGE_DEPLOYMENT_WARNING"

| "LIST_OVERHEAD_QUOTA_EXCEED"

| "MISSING_TYPE_DEPENDENCY"

| "NEXT_HOP_ADDRESS_NOT_ASSIGNED"

| "NEXT_HOP_CANNOT_IP_FORWARD"

| "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE"

| "NEXT_HOP_INSTANCE_NOT_FOUND"

| "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"

| "NEXT_HOP_NOT_RUNNING"

| "NOT_CRITICAL_ERROR"

| "NO_RESULTS_ON_PAGE"

| "PARTIAL_SUCCESS"

| "QUOTA_INFO_UNAVAILABLE"

| "REQUIRED_TOS_AGREEMENT"

| "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING"

| "RESOURCE_NOT_DELETED"

| "SCHEMA_VALIDATION_IGNORED"

| "SINGLE_INSTANCE_PROPERTY_TEMPLATE"

| "UNDECLARED_PROPERTIES"

| "UNREACHABLE";

data?: {

key?: string;

value?: string;

}[];

message?: string;

}[];

}

§Properties

asPaths?: RouteAsPath[]

[src]

[Output Only] AS path.

creationTimestamp?: string

[src]

[Output Only] Creation timestamp in RFC3339 text format.

description?: string

[src]

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

destRange?: string

[src]

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.

id?: bigint

[src]

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

kind?: string

[src]

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

name?: string

[src]

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.

network?: string

[src]

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

nextHopGateway?: string

[src]

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

nextHopHub?: string

[src]

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

nextHopIlb?: string

[src]

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.

nextHopInstance?: string

[src]

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/

nextHopInterRegionCost?: number

[src]

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

nextHopIp?: string

[src]

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.

nextHopMed?: number

[src]

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

nextHopNetwork?: string

[src]

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

nextHopOrigin?: "EGP" | "IGP" | "INCOMPLETE"

[src]

[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.

nextHopPeering?: string

[src]

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

nextHopVpnTunnel?: string

[src]

The URL to a VpnTunnel that should handle matching packets.

params?: RouteParams

[src]

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

priority?: number

[src]

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.

routeStatus?: "ACTIVE" | "DROPPED" | "INACTIVE" | "PENDING"

[src]

[Output only] The status of the route.

routeType?: "BGP" | "STATIC" | "SUBNET" | "TRANSIT"

[src]

[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

selfLink?: string

[src]

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

tags?: string[]

[src]

A list of instance tags to which this route applies.

warnings?: {

code?:

| "CLEANUP_FAILED"

| "DEPRECATED_RESOURCE_USED"

| "DEPRECATED_TYPE_USED"

| "DISK_SIZE_LARGER_THAN_IMAGE_SIZE"

| "EXPERIMENTAL_TYPE_USED"

| "EXTERNAL_API_WARNING"

| "FIELD_VALUE_OVERRIDEN"

| "INJECTED_KERNELS_DEPRECATED"

| "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB"

| "LARGE_DEPLOYMENT_WARNING"

| "LIST_OVERHEAD_QUOTA_EXCEED"

| "MISSING_TYPE_DEPENDENCY"

| "NEXT_HOP_ADDRESS_NOT_ASSIGNED"

| "NEXT_HOP_CANNOT_IP_FORWARD"

| "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE"

| "NEXT_HOP_INSTANCE_NOT_FOUND"

| "NEXT_HOP_INSTANCE_NOT_ON_NETWORK"

| "NEXT_HOP_NOT_RUNNING"

| "NOT_CRITICAL_ERROR"

| "NO_RESULTS_ON_PAGE"

| "PARTIAL_SUCCESS"

| "QUOTA_INFO_UNAVAILABLE"

| "REQUIRED_TOS_AGREEMENT"

| "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING"

| "RESOURCE_NOT_DELETED"

| "SCHEMA_VALIDATION_IGNORED"

| "SINGLE_INSTANCE_PROPERTY_TEMPLATE"

| "UNDECLARED_PROPERTIES"

| "UNREACHABLE";

data?: {

key?: string;

value?: string;

}[];

message?: string;

}[]

[src]

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