Google Cloud Deploy V1 Client - Class DeployPolicyEvaluationEvent (1.1.1)

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 message google.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 the Delivery Pipeline.

↳ delivery_pipeline string

The name of the Delivery Pipeline.

↳ target_uid string

Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.

↳ target string

The name of the Target. This is an optional field, as a Target may 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 the DeployPolicy.

↳ deploy_policy_uid string

Unique identifier of the DeployPolicy.

↳ 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 the Delivery Pipeline.

Returns
Type Description
string

setPipelineUid

Unique identifier of the Delivery Pipeline.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeliveryPipeline

The name of the Delivery Pipeline.

Returns
Type Description
string

setDeliveryPipeline

The name of the Delivery Pipeline.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetUid

Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Returns
Type Description
string

setTargetUid

Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Parameter
Name Description
var string
Returns
Type Description
$this

getTarget

The name of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Returns
Type Description
string

setTarget

The name of the Target. This is an optional field, as a Target may 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 the DeployPolicy.

Returns
Type Description
string

setDeployPolicy

The name of the DeployPolicy.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeployPolicyUid

Unique identifier of the DeployPolicy.

Returns
Type Description
string

setDeployPolicyUid

Unique identifier of the DeployPolicy.

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOverrides

Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.

Parameter
Name Description
var int[]
Returns
Type Description
$this