Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class 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: 19
Generated from protobuf message google.cloud.networkconnectivity.v1.PolicyBasedRoute
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ virtual_machine
Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute\VirtualMachine
Optional. VM instances to which this policy based route applies to.
↳ interconnect_attachment
Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute\InterconnectAttachment
Optional. The interconnect attachments to which this route applies to.
↳ next_hop_ilb_ip
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.
↳ name
string
Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
↳ create_time
↳ update_time
↳ labels
↳ description
string
Optional. An optional description of this resource. Provide this field when you create the resource.
↳ network
string
Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.
↳ filter
Google\Cloud\NetworkConnectivity\V1\PolicyBasedRoute\Filter
Required. The filter to match L4 traffic.
↳ priority
int
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 1000. The priority value must be from 1 to 65535, inclusive.
↳ 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.
↳ self_link
string
Output only. Server-defined fully-qualified URL for this resource.
↳ kind
string
Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.
getVirtualMachine
Optional. VM instances to which this policy based route applies to.
hasVirtualMachine
setVirtualMachine
Optional. VM instances to which this policy based route applies to.
$this
getInterconnectAttachment
Optional. The interconnect attachments to which this route applies to.
hasInterconnectAttachment
setInterconnectAttachment
Optional. The interconnect attachments to which this route applies to.
$this
getNextHopIlbIp
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.
string
hasNextHopIlbIp
setNextHopIlbIp
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.
var
string
$this
getName
Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
string
setName
Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
var
string
$this
getCreateTime
Output only. Time when the PolicyBasedRoute was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the PolicyBasedRoute was created.
$this
getUpdateTime
Output only. Time when the PolicyBasedRoute was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the PolicyBasedRoute was updated.
$this
getLabels
User-defined labels.
setLabels
User-defined labels.
$this
getDescription
Optional. An optional description of this resource. Provide this field when you create the resource.
string
setDescription
Optional. An optional description of this resource. Provide this field when you create the resource.
var
string
$this
getNetwork
Required. Fully-qualified URL of the network that this route applies to. e.g.
projects/my-project/global/networks/my-network.
string
setNetwork
Required. Fully-qualified URL of the network that this route applies to. e.g.
projects/my-project/global/networks/my-network.
var
string
$this
getFilter
Required. The filter to match L4 traffic.
hasFilter
clearFilter
setFilter
Required. The filter to match L4 traffic.
$this
getPriority
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 1000. The priority value must be from 1 to 65535, inclusive.
int
setPriority
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 1000. The priority value must be from 1 to 65535, inclusive.
var
int
$this
getWarnings
Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.
setWarnings
Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.
$this
getSelfLink
Output only. Server-defined fully-qualified URL for this resource.
string
setSelfLink
Output only. Server-defined fully-qualified URL for this resource.
var
string
$this
getKind
Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.
string
setKind
Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.
var
string
$this
getTarget
string
getNextHop
string
