Reference documentation and code samples for the Compute V1 Client class RoutePolicy.
Generated from protobuf message google.cloud.compute.v1.RoutePolicy
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ description
string
An optional description of route policy.
↳ fingerprint
string
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
↳ name
string
Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
↳ type
string
Check the Type enum for the list of possible values.
getDescription
An optional description of route policy.
Returns
Type
Description
string
hasDescription
clearDescription
setDescription
An optional description of route policy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFingerprint
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
Returns
Type
Description
string
hasFingerprint
clearFingerprint
setFingerprint
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getName
Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
Returns
Type
Description
string
hasName
clearName
setName
Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTerms
List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class RoutePolicy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.RoutePolicy)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.RoutePolicy)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.RoutePolicy)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.RoutePolicy)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.RoutePolicy)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.RoutePolicy)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.RoutePolicy)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.RoutePolicy)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.RoutePolicy)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.RoutePolicy)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.RoutePolicy)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.RoutePolicy)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.RoutePolicy)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.RoutePolicy)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.RoutePolicy)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.RoutePolicy)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.RoutePolicy)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.RoutePolicy)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.RoutePolicy)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.RoutePolicy)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.RoutePolicy)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.RoutePolicy)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.RoutePolicy)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.RoutePolicy)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.RoutePolicy)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.RoutePolicy)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.RoutePolicy)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.RoutePolicy)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.RoutePolicy)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.RoutePolicy) \nReference documentation and code samples for the Compute V1 Client class RoutePolicy.\n\nGenerated from protobuf message `google.cloud.compute.v1.RoutePolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDescription\n\nAn optional description of route policy.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional description of route policy.\n\n### getFingerprint\n\nA fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.\n\n### hasFingerprint\n\n### clearFingerprint\n\n### setFingerprint\n\nA fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.\n\n### getName\n\nRoute Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.\n\n### hasName\n\n### clearName\n\n### setName\n\nRoute Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.\n\n### getTerms\n\nList of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.\n\n### setTerms\n\nList of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.\n\n### getType\n\nCheck the Type enum for the list of possible values.\n\n### hasType\n\n### clearType\n\n### setType\n\nCheck the Type enum for the list of possible values."]]