Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute (v1.0.0)

Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute.

Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the PolicyBasedRoute was created.

#description

def description() -> ::String

Returns

(::String) — Optional. An optional description of this resource. Provide this field when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. An optional description of this resource. Provide this field when you create the resource.

Returns

(::String) — Optional. An optional description of this resource. Provide this field when you create the resource.

#filter

def filter() -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.

#filter=

def filter=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter

Parameter

value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Filter) — Required. The filter to match L4 traffic.

#interconnect_attachment

def interconnect_attachment() -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments to which this route applies to.

#interconnect_attachment=

def interconnect_attachment=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment

Parameter

value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments to which this route applies to.

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::InterconnectAttachment) — Optional. The interconnect attachments to which this route applies to.

#kind

def kind() -> ::String

Returns

(::String) — Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-defined labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — User-defined labels.

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-defined labels.

#name

def name() -> ::String

Returns

(::String) — Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

#name=

def name=(value) -> ::String

Parameter

value (::String) — Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

Returns

(::String) — Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

#network

def network() -> ::String

Returns

(::String) — Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

#network=

def network=(value) -> ::String

Parameter

value (::String) — Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

Returns

(::String) — Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

#next_hop_ilb_ip

def next_hop_ilb_ip() -> ::String

Returns

(::String) — Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

#next_hop_ilb_ip=

def next_hop_ilb_ip=(value) -> ::String

Parameter

value (::String) — Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

Returns

(::String) — Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

#next_hop_other_routes

def next_hop_other_routes() -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop of the packet.

#next_hop_other_routes=

def next_hop_other_routes=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes

Parameter

value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop of the packet.

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::OtherRoutes) — Optional. Other routes that will be referenced to determine the next hop of the packet.

#priority

def priority() -> ::Integer

Returns

(::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
1. The priority value must be from 1 to 65535, inclusive.

#priority=

def priority=(value) -> ::Integer

Parameter

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
1. The priority value must be from 1 to 65535, inclusive.

Returns

(::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
1. The priority value must be from 1 to 65535, inclusive.

#self_link

def self_link() -> ::String

Returns

(::String) — Output only. Server-defined fully-qualified URL for this resource.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the PolicyBasedRoute was updated.

#virtual_machine

def virtual_machine() -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances to which this policy based route applies to.

#virtual_machine=

def virtual_machine=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine

Parameter

value (::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances to which this policy based route applies to.

Returns

(::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::VirtualMachine) — Optional. VM instances to which this policy based route applies to.

#warnings

def warnings() -> ::Array<::Google::Cloud::NetworkConnectivity::V1::PolicyBasedRoute::Warnings>

Returns

(::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.