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
Methods
__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.
↳ 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_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: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule
↳ 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_ip
string
The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
↳ next_hop_network
string
The URL of the local network if it should handle matching packets.
↳ 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.
↳ 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< Google\Cloud\Compute\V1\Warnings
>
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
getAsPaths
[Output Only] AS path.
Generated from protobuf field repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;
Google\Protobuf\Internal\RepeatedField
setAsPaths
[Output Only] AS path.
Generated from protobuf field repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getDescription
An optional description of this resource. Provide this field when you create the resource.
Generated from protobuf field optional string description = 422937596;
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this field when you create the resource.
Generated from protobuf field optional string description = 422937596;
var
string
$this
getDestRange
The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.
Generated from protobuf field optional string dest_range = 381327712;
string
hasDestRange
clearDestRange
setDestRange
The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.
Generated from protobuf field optional string dest_range = 381327712;
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
var
int|string
$this
getKind
[Output Only] Type of this resource. Always compute#routes for Route resources.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of this resource. Always compute#routes for Route resources.
Generated from protobuf field optional string kind = 3292052;
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.
Generated from protobuf field optional string name = 3373707;
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.
Generated from protobuf field optional string name = 3373707;
var
string
$this
getNetwork
Fully-qualified URL of the network that this route applies to.
Generated from protobuf field optional string network = 232872494;
string
hasNetwork
clearNetwork
setNetwork
Fully-qualified URL of the network that this route applies to.
Generated from protobuf field optional string network = 232872494;
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
Generated from protobuf field optional string next_hop_gateway = 377175298;
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
Generated from protobuf field optional string next_hop_gateway = 377175298;
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: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule
Generated from protobuf field optional string next_hop_ilb = 198679901;
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: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule
Generated from protobuf field optional string next_hop_ilb = 198679901;
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/
Generated from protobuf field optional string next_hop_instance = 393508247;
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/
Generated from protobuf field optional string next_hop_instance = 393508247;
var
string
$this
getNextHopIp
The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Generated from protobuf field optional string next_hop_ip = 110319529;
string
hasNextHopIp
clearNextHopIp
setNextHopIp
The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Generated from protobuf field optional string next_hop_ip = 110319529;
var
string
$this
getNextHopNetwork
The URL of the local network if it should handle matching packets.
Generated from protobuf field optional string next_hop_network = 262295788;
string
hasNextHopNetwork
clearNextHopNetwork
setNextHopNetwork
The URL of the local network if it should handle matching packets.
Generated from protobuf field optional string next_hop_network = 262295788;
var
string
$this
getNextHopPeering
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Generated from protobuf field optional string next_hop_peering = 412682750;
string
hasNextHopPeering
clearNextHopPeering
setNextHopPeering
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Generated from protobuf field optional string next_hop_peering = 412682750;
var
string
$this
getNextHopVpnTunnel
The URL to a VpnTunnel that should handle matching packets.
Generated from protobuf field optional string next_hop_vpn_tunnel = 519844501;
string
hasNextHopVpnTunnel
clearNextHopVpnTunnel
setNextHopVpnTunnel
The URL to a VpnTunnel that should handle matching packets.
Generated from protobuf field optional string next_hop_vpn_tunnel = 519844501;
var
string
$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.
Generated from protobuf field optional uint32 priority = 445151652;
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.
Generated from protobuf field optional uint32 priority = 445151652;
var
int
$this
getRouteStatus
[Output only] The status of the route.
Check the RouteStatus enum for the list of possible values.
Generated from protobuf field optional string route_status = 418162344;
string
hasRouteStatus
clearRouteStatus
setRouteStatus
[Output only] The status of the route.
Check the RouteStatus enum for the list of possible values.
Generated from protobuf field optional string route_status = 418162344;
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.
Generated from protobuf field optional string route_type = 375888752;
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.
Generated from protobuf field optional string route_type = 375888752;
var
string
$this
getSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$this
getTags
A list of instance tags to which this route applies.
Generated from protobuf field repeated string tags = 3552281;
Google\Protobuf\Internal\RepeatedField
setTags
A list of instance tags to which this route applies.
Generated from protobuf field repeated string tags = 3552281;
var
string[]
$this
getWarnings
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;
Google\Protobuf\Internal\RepeatedField
setWarnings
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;
$this
