Compute V1 Client - Class RoutePolicy (1.35.0)

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.

↳ terms
array< RoutePolicyPolicyTerm >

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.

Returns
Type
Description

setTerms

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.

Parameter
Name
Description
var
Returns
Type
Description
$this

getType

Check the Type enum for the list of possible values.

Returns
Type
Description
string

hasType

clearType

setType

Check the Type enum for the list of possible values.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: