Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class Route.
A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.
Generated from protobuf message google.cloud.networkconnectivity.v1.Route
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
↳ create_time
↳ update_time
↳ ip_cidr_range
string
The destination IP address range.
↳ type
int
Output only. The route's type. Its type is determined by the properties of its IP address range.
↳ next_hop_vpc_network
↳ labels
array| Google\Protobuf\Internal\MapField
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
↳ description
string
An optional description of the route.
↳ uid
string
Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid
.
↳ state
int
Output only. The current lifecycle state of the route.
↳ spoke
string
Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
↳ location
string
Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
↳ priority
int|string
Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
↳ next_hop_vpn_tunnel
↳ next_hop_router_appliance_instance
NextHopRouterApplianceInstance
Immutable. The next-hop Router appliance instance for packets on this route.
↳ next_hop_interconnect_attachment
getName
Immutable. The name of the route. Route names must be unique. Route names
use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
string
setName
Immutable. The name of the route. Route names must be unique. Route names
use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
var
string
$this
getCreateTime
Output only. The time the route was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the route was created.
$this
getUpdateTime
Output only. The time the route was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the route was last updated.
$this
getIpCidrRange
The destination IP address range.
string
setIpCidrRange
The destination IP address range.
var
string
$this
getType
Output only. The route's type. Its type is determined by the properties of its IP address range.
int
setType
Output only. The route's type. Its type is determined by the properties of its IP address range.
var
int
$this
getNextHopVpcNetwork
Immutable. The destination VPC network for packets on this route.
hasNextHopVpcNetwork
clearNextHopVpcNetwork
setNextHopVpcNetwork
Immutable. The destination VPC network for packets on this route.
$this
getLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
setLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
$this
getDescription
An optional description of the route.
string
setDescription
An optional description of the route.
var
string
$this
getUid
Output only. The Google-generated UUID for the route. This value is unique
across all Network Connectivity Center route resources. If a
route is deleted and another with the same name is created,
the new route is assigned a different uid
.
string
setUid
Output only. The Google-generated UUID for the route. This value is unique
across all Network Connectivity Center route resources. If a
route is deleted and another with the same name is created,
the new route is assigned a different uid
.
var
string
$this
getState
Output only. The current lifecycle state of the route.
int
setState
Output only. The current lifecycle state of the route.
var
int
$this
getSpoke
Immutable. The spoke that this route leads to.
Example: projects/12345/locations/global/spokes/SPOKE
string
setSpoke
Immutable. The spoke that this route leads to.
Example: projects/12345/locations/global/spokes/SPOKE
var
string
$this
getLocation
Output only. The origin location of the route.
Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
string
setLocation
Output only. The origin location of the route.
Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
var
string
$this
getPriority
Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
int|string
setPriority
Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
var
int|string
$this
getNextHopVpnTunnel
Immutable. The next-hop VPN tunnel for packets on this route.
hasNextHopVpnTunnel
clearNextHopVpnTunnel
setNextHopVpnTunnel
Immutable. The next-hop VPN tunnel for packets on this route.
$this
getNextHopRouterApplianceInstance
Immutable. The next-hop Router appliance instance for packets on this route.
hasNextHopRouterApplianceInstance
clearNextHopRouterApplianceInstance
setNextHopRouterApplianceInstance
Immutable. The next-hop Router appliance instance for packets on this route.
$this
getNextHopInterconnectAttachment
Immutable. The next-hop VLAN attachment for packets on this route.
hasNextHopInterconnectAttachment
clearNextHopInterconnectAttachment
setNextHopInterconnectAttachment
Immutable. The next-hop VLAN attachment for packets on this route.
$this
