Compute V1 Client - Class Route (2.4.0)

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 theRoutes overview.

Generated from protobuf message google.cloud.compute.v1.Route

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ as_paths array<RouteAsPath>

Output only. [Output Only] AS path.
↳ creation_timestamp string

Output only. [Output Only] Creation timestamp inRFC3339 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. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind string

Output only. [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 withRFC1035. 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. [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 typeloadBalancingScheme=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. [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_interconnect_attachment string

Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.
↳ 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. [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. [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. [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. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. Check the RouteStatus enum for the list of possible values.
↳ route_type string

Output only. [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. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

getAsPaths

Output only. [Output Only] AS path.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAsPaths

Output only. [Output Only] AS path.

Parameter
Name Description
var array<RouteAsPath>
Returns
Type Description
$this

getCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

hasDescription

clearDescription

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

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

Returns
Type Description
int|string

hasId

clearId

setId

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

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

Returns
Type Description
string

hasKind

clearKind

setKind

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

Parameter
Name Description
var string
Returns
Type Description
$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 withRFC1035. 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.

Returns
Type Description
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 withRFC1035. 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetwork

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

Returns
Type Description
string

hasNetwork

clearNetwork

setNetwork

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

Parameter
Name Description
var string
Returns
Type Description
$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

Returns
Type Description
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

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopHub

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

Returns
Type Description
string

hasNextHopHub

clearNextHopHub

setNextHopHub

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

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopIlb

The URL to a forwarding rule of typeloadBalancingScheme=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.
Returns
Type Description
string

hasNextHopIlb

clearNextHopIlb

setNextHopIlb

The URL to a forwarding rule of typeloadBalancingScheme=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.
Parameter
Name Description
var string
Returns
Type Description
$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/

Returns
Type Description
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/

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopInterRegionCost

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

Returns
Type Description
int

hasNextHopInterRegionCost

clearNextHopInterRegionCost

setNextHopInterRegionCost

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

Parameter
Name Description
var int
Returns
Type Description
$this

getNextHopInterconnectAttachment

Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route.

This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.

Returns
Type Description
string

hasNextHopInterconnectAttachment

clearNextHopInterconnectAttachment

setNextHopInterconnectAttachment

Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route.

This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopMed

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

Returns
Type Description
int

hasNextHopMed

clearNextHopMed

setNextHopMed

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

Parameter
Name Description
var int
Returns
Type Description
$this

getNextHopNetwork

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

Returns
Type Description
string

hasNextHopNetwork

clearNextHopNetwork

setNextHopNetwork

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

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopOrigin

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

Returns
Type Description
string

hasNextHopOrigin

clearNextHopOrigin

setNextHopOrigin

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

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopPeering

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

Returns
Type Description
string

hasNextHopPeering

clearNextHopPeering

setNextHopPeering

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

Parameter
Name Description
var string
Returns
Type Description
$this

getNextHopVpnTunnel

The URL to a VpnTunnel that should handle matching packets.

Returns
Type Description
string

hasNextHopVpnTunnel

clearNextHopVpnTunnel

setNextHopVpnTunnel

The URL to a VpnTunnel that should handle matching packets.

Parameter
Name Description
var string
Returns
Type Description
$this

getParams

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

Returns
Type Description
RouteParams|null

hasParams

clearParams

setParams

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

Parameter
Name Description
var RouteParams
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$this

getRouteStatus

[Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration.

Check the RouteStatus enum for the list of possible values.

Returns
Type Description
string

hasRouteStatus

clearRouteStatus

setRouteStatus

[Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration.

Check the RouteStatus enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getRouteType

Output only. [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.
Returns
Type Description
string

hasRouteType

clearRouteType

setRouteType

Output only. [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.
Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

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

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTags

A list of instance tags to which this route applies.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

A list of instance tags to which this route applies.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getWarnings

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setWarnings

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

Parameter
Name Description
var array<Warnings>
Returns
Type Description
$this