Reference documentation and code samples for the Google Cloud Network Management V1 Client class RouteInfo.
For display only. Metadata associated with a Compute Engine route.
Generated from protobuf message google.cloud.networkmanagement.v1.RouteInfo
Namespace
Google \ Cloud \ NetworkManagement \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ route_type |
int
Type of route. |
↳ next_hop_type |
int
Type of next hop. |
↳ route_scope |
int
Indicates where route is applicable. |
↳ display_name |
string
Name of a route. |
↳ uri |
string
URI of a route (if applicable). |
↳ region |
string
Region of the route (if applicable). |
↳ dest_ip_range |
string
Destination IP range of the route. |
↳ next_hop |
string
Next hop of the route. |
↳ network_uri |
string
URI of a Compute Engine network. NETWORK routes only. |
↳ priority |
int
Priority of the route. |
↳ instance_tags |
array
Instance tags of the route. |
↳ src_ip_range |
string
Source IP address range of the route. Policy based routes only. |
↳ dest_port_ranges |
array
Destination port ranges of the route. Policy based routes only. |
↳ src_port_ranges |
array
Source port ranges of the route. Policy based routes only. |
↳ protocols |
array
Protocols of the route. Policy based routes only. |
↳ ncc_hub_uri |
string
URI of a NCC Hub. NCC_HUB routes only. |
↳ ncc_spoke_uri |
string
URI of a NCC Spoke. NCC_HUB routes only. |
↳ advertised_route_source_router_uri |
string
For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix. |
↳ advertised_route_next_hop_uri |
string
For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network. |
getRouteType
Type of route.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRouteType
Type of route.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextHopType
Type of next hop.
| Returns | |
|---|---|
| Type | Description |
int |
|
setNextHopType
Type of next hop.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRouteScope
Indicates where route is applicable.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRouteScope
Indicates where route is applicable.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Name of a route.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Name of a route.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUri
URI of a route (if applicable).
| Returns | |
|---|---|
| Type | Description |
string |
|
setUri
URI of a route (if applicable).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegion
Region of the route (if applicable).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegion
Region of the route (if applicable).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestIpRange
Destination IP range of the route.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDestIpRange
Destination IP range of the route.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextHop
Next hop of the route.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNextHop
Next hop of the route.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkUri
URI of a Compute Engine network. NETWORK routes only.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetworkUri
URI of a Compute Engine network. NETWORK routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPriority
Priority of the route.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPriority
Priority of the route.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstanceTags
Instance tags of the route.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInstanceTags
Instance tags of the route.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSrcIpRange
Source IP address range of the route. Policy based routes only.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSrcIpRange
Source IP address range of the route. Policy based routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestPortRanges
Destination port ranges of the route. Policy based routes only.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDestPortRanges
Destination port ranges of the route. Policy based routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSrcPortRanges
Source port ranges of the route. Policy based routes only.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSrcPortRanges
Source port ranges of the route. Policy based routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProtocols
Protocols of the route. Policy based routes only.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProtocols
Protocols of the route. Policy based routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNccHubUri
URI of a NCC Hub. NCC_HUB routes only.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasNccHubUri
clearNccHubUri
setNccHubUri
URI of a NCC Hub. NCC_HUB routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNccSpokeUri
URI of a NCC Spoke. NCC_HUB routes only.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasNccSpokeUri
clearNccSpokeUri
setNccSpokeUri
URI of a NCC Spoke. NCC_HUB routes only.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdvertisedRouteSourceRouterUri
For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdvertisedRouteSourceRouterUri
clearAdvertisedRouteSourceRouterUri
setAdvertisedRouteSourceRouterUri
For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdvertisedRouteNextHopUri
For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdvertisedRouteNextHopUri
clearAdvertisedRouteNextHopUri
setAdvertisedRouteNextHopUri
For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|