Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::RouteInfo.
For display only. Metadata associated with a Compute Engine route.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#advertised_route_next_hop_uri
def advertised_route_next_hop_uri() -> ::String
Returns
- (::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.
#advertised_route_next_hop_uri=
def advertised_route_next_hop_uri=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#advertised_route_source_router_uri
def advertised_route_source_router_uri() -> ::String
Returns
- (::String) — For ADVERTISED dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.
#advertised_route_source_router_uri=
def advertised_route_source_router_uri=(value) -> ::String
Parameter
- value (::String) — For ADVERTISED dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.
Returns
- (::String) — For ADVERTISED dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.
#dest_ip_range
def dest_ip_range() -> ::String
Returns
- (::String) — Destination IP range of the route.
#dest_ip_range=
def dest_ip_range=(value) -> ::String
Parameter
- value (::String) — Destination IP range of the route.
Returns
- (::String) — Destination IP range of the route.
#dest_port_ranges
def dest_port_ranges() -> ::Array<::String>
Returns
- (::Array<::String>) — Destination port ranges of the route. POLICY_BASED routes only.
#dest_port_ranges=
def dest_port_ranges=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Destination port ranges of the route. POLICY_BASED routes only.
Returns
- (::Array<::String>) — Destination port ranges of the route. POLICY_BASED routes only.
#display_name
def display_name() -> ::String
Returns
- (::String) — Name of a route.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Name of a route.
Returns
- (::String) — Name of a route.
#instance_tags
def instance_tags() -> ::Array<::String>
Returns
- (::Array<::String>) — Instance tags of the route.
#instance_tags=
def instance_tags=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Instance tags of the route.
Returns
- (::Array<::String>) — Instance tags of the route.
#ncc_hub_route_uri
def ncc_hub_route_uri() -> ::String
Returns
- (::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.
#ncc_hub_route_uri=
def ncc_hub_route_uri=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#ncc_hub_uri
def ncc_hub_uri() -> ::String
Returns
- (::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_hub_uri=
def ncc_hub_uri=(value) -> ::String
Parameter
- value (::String) — URI of the NCC Hub the route is advertised by. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.
Returns
- (::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
def ncc_spoke_uri() -> ::String
Returns
- (::String) — URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.
#ncc_spoke_uri=
def ncc_spoke_uri=(value) -> ::String
Parameter
- value (::String) — URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.
Returns
- (::String) — URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.
#network_uri
def network_uri() -> ::String
Returns
- (::String) — URI of a VPC network where route is located.
#network_uri=
def network_uri=(value) -> ::String
Parameter
- value (::String) — URI of a VPC network where route is located.
Returns
- (::String) — URI of a VPC network where route is located.
#next_hop
def next_hop() -> ::String
Returns
- (::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.
#next_hop=
def next_hop=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#next_hop_network_uri
def next_hop_network_uri() -> ::String
Returns
- (::String) — URI of a VPC network where the next hop resource is located.
#next_hop_network_uri=
def next_hop_network_uri=(value) -> ::String
Parameter
- value (::String) — URI of a VPC network where the next hop resource is located.
Returns
- (::String) — URI of a VPC network where the next hop resource is located.
#next_hop_type
def next_hop_type() -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::NextHopType
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::NextHopType) — Type of next hop.
#next_hop_type=
def next_hop_type=(value) -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::NextHopType
Parameter
- value (::Google::Cloud::NetworkManagement::V1::RouteInfo::NextHopType) — Type of next hop.
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::NextHopType) — Type of next hop.
#next_hop_uri
def next_hop_uri() -> ::String
Returns
- (::String) — URI of the next hop resource.
#next_hop_uri=
def next_hop_uri=(value) -> ::String
Parameter
- value (::String) — URI of the next hop resource.
Returns
- (::String) — URI of the next hop resource.
#originating_route_display_name
def originating_route_display_name() -> ::String
Returns
- (::String) — For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route.
#originating_route_display_name=
def originating_route_display_name=(value) -> ::String
Parameter
- value (::String) — For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route.
Returns
- (::String) — For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route.
#originating_route_uri
def originating_route_uri() -> ::String
Returns
- (::String) — For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route.
#originating_route_uri=
def originating_route_uri=(value) -> ::String
Parameter
- value (::String) — For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route.
Returns
- (::String) — For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route.
#priority
def priority() -> ::Integer
Returns
- (::Integer) — Priority of the route.
#priority=
def priority=(value) -> ::Integer
Parameter
- value (::Integer) — Priority of the route.
Returns
- (::Integer) — Priority of the route.
#protocols
def protocols() -> ::Array<::String>
Returns
- (::Array<::String>) — Protocols of the route. POLICY_BASED routes only.
#protocols=
def protocols=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Protocols of the route. POLICY_BASED routes only.
Returns
- (::Array<::String>) — Protocols of the route. POLICY_BASED routes only.
#region
def region() -> ::String
Returns
- (::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.
#region=
def region=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#route_scope
def route_scope() -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteScope
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteScope) — Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests.
#route_scope=
def route_scope=(value) -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteScope
Parameter
- value (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteScope) — Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests.
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteScope) — Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests.
#route_type
def route_type() -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteType
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteType) — Type of route.
#route_type=
def route_type=(value) -> ::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteType
Parameter
- value (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteType) — Type of route.
Returns
- (::Google::Cloud::NetworkManagement::V1::RouteInfo::RouteType) — Type of route.
#src_ip_range
def src_ip_range() -> ::String
Returns
- (::String) — Source IP address range of the route. POLICY_BASED routes only.
#src_ip_range=
def src_ip_range=(value) -> ::String
Parameter
- value (::String) — Source IP address range of the route. POLICY_BASED routes only.
Returns
- (::String) — Source IP address range of the route. POLICY_BASED routes only.
#src_port_ranges
def src_port_ranges() -> ::Array<::String>
Returns
- (::Array<::String>) — Source port ranges of the route. POLICY_BASED routes only.
#src_port_ranges=
def src_port_ranges=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Source port ranges of the route. POLICY_BASED routes only.
Returns
- (::Array<::String>) — Source port ranges of the route. POLICY_BASED routes only.
#uri
def uri() -> ::String
Returns
- (::String) — URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.
#uri=
def uri=(value) -> ::String
Parameter
- value (::String) — URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.
Returns
- (::String) — URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.