# Google Cloud Network Management V1 Client - Class RouteInfo (2.9.2)

2.9.2 (latest) 2.9.1 2.8.0 2.7.0 2.6.1 2.5.0 2.4.2 2.3.2 2.2.1 2.1.1 2.0.1 1.7.3 1.5.0 1.4.2 1.3.0 1.2.0 1.1.1 1.0.5 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 \\ V1

## Methods

### __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. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests. |
| `↳ display_name` | `string` Name of a route. |
| `↳ uri` | `string` URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. |
| `↳ region` | `string` Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to. If set to "all" for POLICY_BASED route, the route applies to VLAN attachments of Cloud Interconnect in all regions. |
| `↳ dest_ip_range` | `string` Destination IP range of the route. |
| `↳ next_hop` | `string` String type of the next hop of the route (for example, "VPN tunnel"). Deprecated in favor of the next_hop_type and next_hop_uri fields, not used in new tests. |
| `↳ network_uri` | `string` URI of a VPC network where route is located. |
| `↳ priority` | `int` Priority of the route. |
| `↳ instance_tags` | `string[]` Instance tags of the route. |
| `↳ src_ip_range` | `string` Source IP address range of the route. POLICY_BASED routes only. |
| `↳ dest_port_ranges` | `string[]` Destination port ranges of the route. POLICY_BASED routes only. |
| `↳ src_port_ranges` | `string[]` Source port ranges of the route. POLICY_BASED routes only. |
| `↳ protocols` | `string[]` Protocols of the route. POLICY_BASED routes only. |
| `↳ ncc_hub_uri` | `string` URI of the NCC Hub the route is advertised by. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. |
| `↳ ncc_spoke_uri` | `string` URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub 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. Deprecated in favor of the next_hop_uri field, not used in new tests. |
| `↳ next_hop_uri` | `string` URI of the next hop resource. |
| `↳ next_hop_network_uri` | `string` URI of a VPC network where the next hop resource is located. |
| `↳ originating_route_uri` | `string` For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. |
| `↳ originating_route_display_name` | `string` For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. |
| `↳ ncc_hub_route_uri` | `string` For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. |

### getRouteType

Type of route.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [RouteType](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.RouteType). |

### setRouteType

Type of route.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [RouteType](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.RouteType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNextHopType

Type of next hop.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [NextHopType](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.NextHopType). |

### setNextHopType

Type of next hop.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [NextHopType](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.NextHopType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRouteScope

Indicates where route is applicable. Deprecated, routes with NCC_HUB scope
are not included in the trace in new tests.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [RouteScope](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.RouteScope). |

### setRouteScope

Indicates where route is applicable. Deprecated, routes with NCC_HUB scope
are not included in the trace in new tests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [RouteScope](https://docs.cloud.google.com/php/docs/reference/cloud-network-management/latest/V1.RouteInfo.RouteScope). |

| **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. SUBNET, STATIC, PEERING_SUBNET (only for peering network)
and POLICY_BASED routes only.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setUri

URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network)
and POLICY_BASED routes only.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRegion

Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED
routes only. If set for POLICY_BASED route, this is a region of VLAN
attachments for Cloud Interconnect the route applies to. If set to "all"
for POLICY_BASED route, the route applies to VLAN attachments of Cloud
Interconnect in all regions.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setRegion

Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED
routes only. If set for POLICY_BASED route, this is a region of VLAN
attachments for Cloud Interconnect the route applies to. If set to "all"
for POLICY_BASED route, the route applies to VLAN attachments of Cloud
Interconnect in all regions.

| **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

String type of the next hop of the route (for example, "VPN tunnel").

Deprecated in favor of the next_hop_type and next_hop_uri fields, not used
in new tests.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setNextHop

String type of the next hop of the route (for example, "VPN tunnel").

Deprecated in favor of the next_hop_type and next_hop_uri fields, not used
in new tests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNetworkUri

URI of a VPC network where route is located.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setNetworkUri

URI of a VPC network where route is located.

| **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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### 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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### 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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### 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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setProtocols

Protocols of the route. POLICY_BASED routes only.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNccHubUri

URI of the NCC Hub the route is advertised by. PEERING_SUBNET and
PEERING_DYNAMIC routes that are advertised by NCC Hub only.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasNccHubUri

### clearNccHubUri

### setNccHubUri

URI of the NCC Hub the route is advertised by. PEERING_SUBNET and
PEERING_DYNAMIC routes that are advertised by NCC Hub only.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNccSpokeUri

URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes
that are advertised by NCC Hub only.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasNccSpokeUri

### clearNccSpokeUri

### setNccSpokeUri

URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes
that are advertised by NCC Hub 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. Deprecated in favor of the next_hop_uri field, not used in new
tests.

| **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. Deprecated in favor of the next_hop_uri field, not used in new
tests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNextHopUri

URI of the next hop resource.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setNextHopUri

URI of the next hop resource.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNextHopNetworkUri

URI of a VPC network where the next hop resource is located.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setNextHopNetworkUri

URI of a VPC network where the next hop resource is located.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOriginatingRouteUri

For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating
SUBNET/STATIC route.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOriginatingRouteUri

For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating
SUBNET/STATIC route.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOriginatingRouteDisplayName

For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of
the originating SUBNET/STATIC/DYNAMIC route.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOriginatingRouteDisplayName

For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of
the originating SUBNET/STATIC/DYNAMIC route.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNccHubRouteUri

For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC
Hub, the URI of the corresponding route in NCC Hub's routing table.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setNccHubRouteUri

For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC
Hub, the URI of the corresponding route in NCC Hub's routing table.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |