Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeployPolicyEvaluationEvent.
Payload proto for "clouddeploy.googleapis.com/deploypolicy_evaluation"
Platform Log event that describes the deploy policy evaluation event.
Generated from protobuf messagegoogle.cloud.deploy.v1.DeployPolicyEvaluationEvent
Namespace
Google \ Cloud \ Deploy \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ message
string
Debug message for when a deploy policy event occurs.
↳ rule_type
string
Rule type (e.g. Restrict Rollouts).
↳ rule
string
Rule id.
↳ pipeline_uid
string
Unique identifier of theDelivery Pipeline.
↳ delivery_pipeline
string
The name of theDelivery Pipeline.
↳ target_uid
string
Unique identifier of theTarget. This is an optional field, as aTargetmay not always be applicable to a policy.
↳ target
string
The name of theTarget. This is an optional field, as aTargetmay not always be applicable to a policy.
↳ invoker
int
What invoked the action (e.g. a user or automation).
↳ deploy_policy
string
The name of theDeployPolicy.
↳ deploy_policy_uid
string
Unique identifier of theDeployPolicy.
↳ allowed
bool
Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended
↳ verdict
int
The policy verdict of the request.
↳ overrides
array
Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.
getMessage
Debug message for when a deploy policy event occurs.
Returns
Type
Description
string
setMessage
Debug message for when a deploy policy event occurs.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRuleType
Rule type (e.g. Restrict Rollouts).
Returns
Type
Description
string
setRuleType
Rule type (e.g. Restrict Rollouts).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRule
Rule id.
Returns
Type
Description
string
setRule
Rule id.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPipelineUid
Unique identifier of theDelivery Pipeline.
Returns
Type
Description
string
setPipelineUid
Unique identifier of theDelivery Pipeline.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDeliveryPipeline
The name of theDelivery Pipeline.
Returns
Type
Description
string
setDeliveryPipeline
The name of theDelivery Pipeline.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTargetUid
Unique identifier of theTarget. This is an optional field, as aTargetmay not always be applicable to a policy.
Returns
Type
Description
string
setTargetUid
Unique identifier of theTarget. This is an optional field, as aTargetmay not always be applicable to a policy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTarget
The name of theTarget. This is an optional field, as aTargetmay not
always be applicable to a policy.
Returns
Type
Description
string
setTarget
The name of theTarget. This is an optional field, as aTargetmay not
always be applicable to a policy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getInvoker
What invoked the action (e.g. a user or automation).
Returns
Type
Description
int
setInvoker
What invoked the action (e.g. a user or automation).
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getDeployPolicy
The name of theDeployPolicy.
Returns
Type
Description
string
setDeployPolicy
The name of theDeployPolicy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDeployPolicyUid
Unique identifier of theDeployPolicy.
Returns
Type
Description
string
setDeployPolicyUid
Unique identifier of theDeployPolicy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAllowed
Whether the request is allowed. Allowed is set as true if:
(1) the request complies with the policy; or
(2) the request doesn't comply with the policy but the policy was
overridden; or
(3) the request doesn't comply with the policy but the policy was suspended
Returns
Type
Description
bool
setAllowed
Whether the request is allowed. Allowed is set as true if:
(1) the request complies with the policy; or
(2) the request doesn't comply with the policy but the policy was
overridden; or
(3) the request doesn't comply with the policy but the policy was suspended
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getVerdict
The policy verdict of the request.
Returns
Type
Description
int
setVerdict
The policy verdict of the request.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getOverrides
Things that could have overridden the policy verdict. Overrides together
with verdict decide whether the request is allowed.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class DeployPolicyEvaluationEvent (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.DeployPolicyEvaluationEvent)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.DeployPolicyEvaluationEvent)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.DeployPolicyEvaluationEvent)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.DeployPolicyEvaluationEvent)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.DeployPolicyEvaluationEvent)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.DeployPolicyEvaluationEvent)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.DeployPolicyEvaluationEvent)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.DeployPolicyEvaluationEvent)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.DeployPolicyEvaluationEvent)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.DeployPolicyEvaluationEvent)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.DeployPolicyEvaluationEvent)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.DeployPolicyEvaluationEvent)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.DeployPolicyEvaluationEvent)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.DeployPolicyEvaluationEvent)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.DeployPolicyEvaluationEvent)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.DeployPolicyEvaluationEvent)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.DeployPolicyEvaluationEvent)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.DeployPolicyEvaluationEvent)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.DeployPolicyEvaluationEvent)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.DeployPolicyEvaluationEvent)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.DeployPolicyEvaluationEvent)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.DeployPolicyEvaluationEvent)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.DeployPolicyEvaluationEvent)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.DeployPolicyEvaluationEvent) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class DeployPolicyEvaluationEvent.\n\nPayload proto for \"clouddeploy.googleapis.com/deploypolicy_evaluation\"\nPlatform Log event that describes the deploy policy evaluation event.\n\nGenerated from protobuf message `google.cloud.deploy.v1.DeployPolicyEvaluationEvent`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMessage\n\nDebug message for when a deploy policy event occurs.\n\n### setMessage\n\nDebug message for when a deploy policy event occurs.\n\n### getRuleType\n\nRule type (e.g. Restrict Rollouts).\n\n### setRuleType\n\nRule type (e.g. Restrict Rollouts).\n\n### getRule\n\nRule id.\n\n### setRule\n\nRule id.\n\n### getPipelineUid\n\nUnique identifier of the `Delivery Pipeline`.\n\n### setPipelineUid\n\nUnique identifier of the `Delivery Pipeline`.\n\n### getDeliveryPipeline\n\nThe name of the `Delivery Pipeline`.\n\n### setDeliveryPipeline\n\nThe name of the `Delivery Pipeline`.\n\n### getTargetUid\n\nUnique identifier of the `Target`. This is an optional field, as a `Target`\nmay not always be applicable to a policy.\n\n### setTargetUid\n\nUnique identifier of the `Target`. This is an optional field, as a `Target`\nmay not always be applicable to a policy.\n\n### getTarget\n\nThe name of the `Target`. This is an optional field, as a `Target` may not\nalways be applicable to a policy.\n\n### setTarget\n\nThe name of the `Target`. This is an optional field, as a `Target` may not\nalways be applicable to a policy.\n\n### getInvoker\n\nWhat invoked the action (e.g. a user or automation).\n\n### setInvoker\n\nWhat invoked the action (e.g. a user or automation).\n\n### getDeployPolicy\n\nThe name of the `DeployPolicy`.\n\n### setDeployPolicy\n\nThe name of the `DeployPolicy`.\n\n### getDeployPolicyUid\n\nUnique identifier of the `DeployPolicy`.\n\n### setDeployPolicyUid\n\nUnique identifier of the `DeployPolicy`.\n\n### getAllowed\n\nWhether the request is allowed. Allowed is set as true if:\n(1) the request complies with the policy; or\n(2) the request doesn't comply with the policy but the policy was\noverridden; or\n(3) the request doesn't comply with the policy but the policy was suspended\n\n### setAllowed\n\nWhether the request is allowed. Allowed is set as true if:\n(1) the request complies with the policy; or\n(2) the request doesn't comply with the policy but the policy was\noverridden; or\n(3) the request doesn't comply with the policy but the policy was suspended\n\n### getVerdict\n\nThe policy verdict of the request.\n\n### setVerdict\n\nThe policy verdict of the request.\n\n### getOverrides\n\nThings that could have overridden the policy verdict. Overrides together\nwith verdict decide whether the request is allowed.\n\n### setOverrides\n\nThings that could have overridden the policy verdict. Overrides together\nwith verdict decide whether the request is allowed."]]
