Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute (v1.9.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute.
Policy-based routes route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the policy-based route always takes precedence.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
defcreate_time()->::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Time when the policy-based route was created.
#description
defdescription()->::String- (::String) — Optional. An optional description of this resource. Provide this field when you create the resource.
#description=
defdescription=(value)->::String- value (::String) — Optional. An optional description of this resource. Provide this field when you create the resource.
- (::String) — Optional. An optional description of this resource. Provide this field when you create the resource.
#filter
deffilter()->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter- (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.
#filter=
deffilter=(value)->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter- value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.
- (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.
#interconnect_attachment
definterconnect_attachment()->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments that this policy-based route
applies to.
Note: The following fields are mutually exclusive:
interconnect_attachment,virtual_machine. If a field in that set is populated, all other fields in the set will automatically be cleared.
#interconnect_attachment=
definterconnect_attachment=(value)->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment-
value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments that this policy-based route
applies to.
Note: The following fields are mutually exclusive:
interconnect_attachment,virtual_machine. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments that this policy-based route
applies to.
Note: The following fields are mutually exclusive:
interconnect_attachment,virtual_machine. If a field in that set is populated, all other fields in the set will automatically be cleared.
#kind
defkind()->::String- (::String) — Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
#labels
deflabels()->::Google::Protobuf::Map{::String=>::String}- (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
#labels=
deflabels=(value)->::Google::Protobuf::Map{::String=>::String}- value (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
- (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.
#name
defname()->::String-
(::String) — Immutable. A unique name of the resource in the form of
projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
#name=
defname=(value)->::String-
value (::String) — Immutable. A unique name of the resource in the form of
projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
-
(::String) — Immutable. A unique name of the resource in the form of
projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
#network
defnetwork()->::String- (::String) — Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
#network=
defnetwork=(value)->::String- value (::String) — Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
- (::String) — Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
#next_hop_ilb_ip
defnext_hop_ilb_ip()->::String-
(::String) — Optional. The IP address of a global-access-enabled L4 ILB that is the
next hop for matching packets. For this version, only nextHopIlbIp is
supported.
Note: The following fields are mutually exclusive:
next_hop_ilb_ip,next_hop_other_routes. If a field in that set is populated, all other fields in the set will automatically be cleared.
#next_hop_ilb_ip=
defnext_hop_ilb_ip=(value)->::String-
value (::String) — Optional. The IP address of a global-access-enabled L4 ILB that is the
next hop for matching packets. For this version, only nextHopIlbIp is
supported.
Note: The following fields are mutually exclusive:
next_hop_ilb_ip,next_hop_other_routes. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::String) — Optional. The IP address of a global-access-enabled L4 ILB that is the
next hop for matching packets. For this version, only nextHopIlbIp is
supported.
Note: The following fields are mutually exclusive:
next_hop_ilb_ip,next_hop_other_routes. If a field in that set is populated, all other fields in the set will automatically be cleared.
#next_hop_other_routes
defnext_hop_other_routes()->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop
of the packet.
Note: The following fields are mutually exclusive:
next_hop_other_routes,next_hop_ilb_ip. If a field in that set is populated, all other fields in the set will automatically be cleared.
#next_hop_other_routes=
defnext_hop_other_routes=(value)->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes-
value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop
of the packet.
Note: The following fields are mutually exclusive:
next_hop_other_routes,next_hop_ilb_ip. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop
of the packet.
Note: The following fields are mutually exclusive:
next_hop_other_routes,next_hop_ilb_ip. If a field in that set is populated, all other fields in the set will automatically be cleared.
#priority
defpriority()->::Integer-
(::Integer) —
Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is
- The priority value must be from 1 to 65535, inclusive.
#priority=
defpriority=(value)->::Integer-
value (::Integer) —
Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is
- The priority value must be from 1 to 65535, inclusive.
-
(::Integer) —
Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is
- The priority value must be from 1 to 65535, inclusive.
#self_link
defself_link()->::String- (::String) — Output only. Server-defined fully-qualified URL for this resource.
#update_time
defupdate_time()->::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Time when the policy-based route was updated.
#virtual_machine
defvirtual_machine()->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances that this policy-based route applies to.
Note: The following fields are mutually exclusive:
virtual_machine,interconnect_attachment. If a field in that set is populated, all other fields in the set will automatically be cleared.
#virtual_machine=
defvirtual_machine=(value)->::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine-
value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances that this policy-based route applies to.
Note: The following fields are mutually exclusive:
virtual_machine,interconnect_attachment. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances that this policy-based route applies to.
Note: The following fields are mutually exclusive:
virtual_machine,interconnect_attachment. If a field in that set is populated, all other fields in the set will automatically be cleared.
#warnings
defwarnings()->::Array<::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Warnings>- (::Array<::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Warnings>) — Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.