Reference documentation and code samples for the Compute V1 Client 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.
Generated from protobuf message google.cloud.compute.v1.Route
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ as_paths
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ description
string
An optional description of this resource. Provide this field when you create the resource.
↳ dest_range
string
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
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind
string
[Output Only] Type of this resource. Always compute#routes for Route resources.
↳ name
string
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
Fully-qualified URL of the network that this route applies to.
↳ next_hop_gateway
string
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
↳ next_hop_hub
string
[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
↳ next_hop_ilb
string
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.
↳ next_hop_instance
string
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/
↳ next_hop_inter_region_cost
int
[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.
↳ next_hop_ip
string
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.
↳ next_hop_med
int
[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
↳ next_hop_network
string
The URL of the local network if it should handle matching packets.
↳ next_hop_origin
string
[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.
↳ next_hop_peering
string
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
↳ next_hop_vpn_tunnel
string
The URL to a VpnTunnel that should handle matching packets.
↳ params
RouteParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
↳ 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.
↳ route_status
string
[Output only] The status of the route. Check the RouteStatus enum for the list of possible values.
↳ route_type
string
[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.
↳ self_link
string
[Output Only] Server-defined fully-qualified URL for this resource.
↳ tags
array
A list of instance tags to which this route applies.
↳ warnings
array< Warnings
>
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
getAsPaths
[Output Only] AS path.
setAsPaths
[Output Only] AS path.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this field when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this field when you create the resource.
var
string
$this
getDestRange
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.
string
hasDestRange
clearDestRange
setDestRange
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.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output Only] Type of this resource. Always compute#routes for Route resources.
string
hasKind
clearKind
setKind
[Output Only] Type of this resource. Always compute#routes for Route resources.
var
string
$this
getName
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.
string
hasName
clearName
setName
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.
var
string
$this
getNetwork
Fully-qualified URL of the network that this route applies to.
string
hasNetwork
clearNetwork
setNetwork
Fully-qualified URL of the network that this route applies to.
var
string
$this
getNextHopGateway
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
string
hasNextHopGateway
clearNextHopGateway
setNextHopGateway
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
var
string
$this
getNextHopHub
[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
string
hasNextHopHub
clearNextHopHub
setNextHopHub
[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
var
string
$this
getNextHopIlb
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.
string
hasNextHopIlb
clearNextHopIlb
setNextHopIlb
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.
var
string
$this
getNextHopInstance
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/
string
hasNextHopInstance
clearNextHopInstance
setNextHopInstance
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/
var
string
$this
getNextHopInterRegionCost
[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.
int
hasNextHopInterRegionCost
clearNextHopInterRegionCost
setNextHopInterRegionCost
[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.
var
int
$this
getNextHopIp
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.
string
hasNextHopIp
clearNextHopIp
setNextHopIp
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.
var
string
$this
getNextHopMed
[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
int
hasNextHopMed
clearNextHopMed
setNextHopMed
[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
var
int
$this
getNextHopNetwork
The URL of the local network if it should handle matching packets.
string
hasNextHopNetwork
clearNextHopNetwork
setNextHopNetwork
The URL of the local network if it should handle matching packets.
var
string
$this
getNextHopOrigin
[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.
string
hasNextHopOrigin
clearNextHopOrigin
setNextHopOrigin
[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.
var
string
$this
getNextHopPeering
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
string
hasNextHopPeering
clearNextHopPeering
setNextHopPeering
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
var
string
$this
getNextHopVpnTunnel
The URL to a VpnTunnel that should handle matching packets.
string
hasNextHopVpnTunnel
clearNextHopVpnTunnel
setNextHopVpnTunnel
The URL to a VpnTunnel that should handle matching packets.
var
string
$this
getParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
hasParams
clearParams
setParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
$this
getPriority
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.
int
hasPriority
clearPriority
setPriority
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.
var
int
$this
getRouteStatus
[Output only] The status of the route.
Check the RouteStatus enum for the list of possible values.
string
hasRouteStatus
clearRouteStatus
setRouteStatus
[Output only] The status of the route.
Check the RouteStatus enum for the list of possible values.
var
string
$this
getRouteType
[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.
string
hasRouteType
clearRouteType
setRouteType
[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.
var
string
$this
getSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
var
string
$this
getTags
A list of instance tags to which this route applies.
setTags
A list of instance tags to which this route applies.
var
string[]
$this
getWarnings
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
setWarnings
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
$this
