Google Cloud Asset V1 Client - Class Rule (1.14.1)

Reference documentation and code samples for the Google Cloud Asset V1 Client class Rule.

This rule message is a customized version of the one defined in the Organization Policy system. In addition to the fields defined in the original organization policy, it contains additional field(s) under specific circumstances to support analysis results.

Generated from protobuf message google.cloud.asset.v1.AnalyzerOrgPolicy.Rule

Namespace

Google \ Cloud \ Asset \ V1 \ AnalyzerOrgPolicy

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ values`	`Google\Cloud\Asset\V1\AnalyzerOrgPolicy\Rule\StringValues` List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.
`↳ allow_all`	`bool` Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints.
`↳ deny_all`	`bool` Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.
`↳ enforce`	`bool` If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. This field can be set only in Policies for boolean constraints.
`↳ condition`	`Google\Type\Expr` The evaluating condition for this rule.

getValues

List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.

Returns
Type	Description
`Google\Cloud\Asset\V1\AnalyzerOrgPolicy\Rule\StringValues\|null`

hasValues

setValues

List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.

Parameter
Name	Description
`var`	`Google\Cloud\Asset\V1\AnalyzerOrgPolicy\Rule\StringValues`

Returns
Type	Description
`$this`

getAllowAll

Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints.

Returns
Type	Description
`bool`

hasAllowAll

setAllowAll

Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDenyAll

Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.

Returns
Type	Description
`bool`

hasDenyAll

setDenyAll

Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEnforce

If true, then the Policy is enforced. If false, then any configuration is acceptable.

This field can be set only in Policies for boolean constraints.

Returns
Type	Description
`bool`

hasEnforce

setEnforce

If true, then the Policy is enforced. If false, then any configuration is acceptable.

This field can be set only in Policies for boolean constraints.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getCondition

The evaluating condition for this rule.

Returns
Type	Description
`Google\Type\Expr\|null`

hasCondition

clearCondition

setCondition

The evaluating condition for this rule.

Parameter
Name	Description
`var`	`Google\Type\Expr`

Returns
Type	Description
`$this`

getKind

Returns
Type	Description
`string`