Reference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::OrgPolicy::V1::Policy::BooleanPolicy.
Used in policy_type to specify how boolean_policy will behave at this
resource.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#enforced
defenforced()->::Boolean
Returns
(::Boolean) — If true, then the Policy is enforced. If false, then any
configuration is acceptable.
Suppose you have a Constraintconstraints/compute.disableSerialPortAccess with constraint_default
set to ALLOW. A Policy for that Constraint exhibits the following
behavior:
If the Policy at this resource has enforced set to false, serial
port connection attempts will be allowed.
If the Policy at this resource has enforced set to true, serial
port connection attempts will be refused.
If the Policy at this resource is RestoreDefault, serial port
connection attempts will be allowed.
If no Policy is set at this resource or anywhere higher in the
resource hierarchy, serial port connection attempts will be allowed.
If no Policy is set at this resource, but one exists higher in the
resource hierarchy, the behavior is as if thePolicy were set at
this resource.
The following examples demonstrate the different possible layerings:
Example 1 (nearest Constraint wins):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has no Policy set.
The constraint at projects/bar and organizations/foo will not be
enforced.
Example 2 (enforcement gets replaced):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has a Policy with:
{enforced: true}
The constraint at organizations/foo is not enforced.
The constraint at projects/bar is enforced.
Example 3 (RestoreDefault):
organizations/foo has a Policy with:
{enforced: true}
projects/bar has a Policy with:
{RestoreDefault: \{}}
The constraint at organizations/foo is enforced.
The constraint at projects/bar is not enforced, because
constraint_default for the Constraint is ALLOW.
#enforced=
defenforced=(value)->::Boolean
Parameter
value (::Boolean) — If true, then the Policy is enforced. If false, then any
configuration is acceptable.
Suppose you have a Constraintconstraints/compute.disableSerialPortAccess with constraint_default
set to ALLOW. A Policy for that Constraint exhibits the following
behavior:
If the Policy at this resource has enforced set to false, serial
port connection attempts will be allowed.
If the Policy at this resource has enforced set to true, serial
port connection attempts will be refused.
If the Policy at this resource is RestoreDefault, serial port
connection attempts will be allowed.
If no Policy is set at this resource or anywhere higher in the
resource hierarchy, serial port connection attempts will be allowed.
If no Policy is set at this resource, but one exists higher in the
resource hierarchy, the behavior is as if thePolicy were set at
this resource.
The following examples demonstrate the different possible layerings:
Example 1 (nearest Constraint wins):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has no Policy set.
The constraint at projects/bar and organizations/foo will not be
enforced.
Example 2 (enforcement gets replaced):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has a Policy with:
{enforced: true}
The constraint at organizations/foo is not enforced.
The constraint at projects/bar is enforced.
Example 3 (RestoreDefault):
organizations/foo has a Policy with:
{enforced: true}
projects/bar has a Policy with:
{RestoreDefault: \{}}
The constraint at organizations/foo is enforced.
The constraint at projects/bar is not enforced, because
constraint_default for the Constraint is ALLOW.
Returns
(::Boolean) — If true, then the Policy is enforced. If false, then any
configuration is acceptable.
Suppose you have a Constraintconstraints/compute.disableSerialPortAccess with constraint_default
set to ALLOW. A Policy for that Constraint exhibits the following
behavior:
If the Policy at this resource has enforced set to false, serial
port connection attempts will be allowed.
If the Policy at this resource has enforced set to true, serial
port connection attempts will be refused.
If the Policy at this resource is RestoreDefault, serial port
connection attempts will be allowed.
If no Policy is set at this resource or anywhere higher in the
resource hierarchy, serial port connection attempts will be allowed.
If no Policy is set at this resource, but one exists higher in the
resource hierarchy, the behavior is as if thePolicy were set at
this resource.
The following examples demonstrate the different possible layerings:
Example 1 (nearest Constraint wins):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has no Policy set.
The constraint at projects/bar and organizations/foo will not be
enforced.
Example 2 (enforcement gets replaced):
organizations/foo has a Policy with:
{enforced: false}
projects/bar has a Policy with:
{enforced: true}
The constraint at organizations/foo is not enforced.
The constraint at projects/bar is enforced.
Example 3 (RestoreDefault):
organizations/foo has a Policy with:
{enforced: true}
projects/bar has a Policy with:
{RestoreDefault: \{}}
The constraint at organizations/foo is enforced.
The constraint at projects/bar is not enforced, because
constraint_default for the Constraint is ALLOW.
[[["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-09 UTC."],[],[],null,["# Cloud Asset V1 API - Class Google::Cloud::OrgPolicy::V1::Policy::BooleanPolicy (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-asset-v1/latest/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [1.4.0](/ruby/docs/reference/google-cloud-asset-v1/1.4.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [1.3.1](/ruby/docs/reference/google-cloud-asset-v1/1.3.1/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [1.2.0](/ruby/docs/reference/google-cloud-asset-v1/1.2.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [1.1.0](/ruby/docs/reference/google-cloud-asset-v1/1.1.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [1.0.2](/ruby/docs/reference/google-cloud-asset-v1/1.0.2/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.32.0](/ruby/docs/reference/google-cloud-asset-v1/0.32.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.31.0](/ruby/docs/reference/google-cloud-asset-v1/0.31.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.30.0](/ruby/docs/reference/google-cloud-asset-v1/0.30.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.29.3](/ruby/docs/reference/google-cloud-asset-v1/0.29.3/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.28.1](/ruby/docs/reference/google-cloud-asset-v1/0.28.1/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.27.0](/ruby/docs/reference/google-cloud-asset-v1/0.27.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.26.1](/ruby/docs/reference/google-cloud-asset-v1/0.26.1/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.25.0](/ruby/docs/reference/google-cloud-asset-v1/0.25.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.24.0](/ruby/docs/reference/google-cloud-asset-v1/0.24.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.23.0](/ruby/docs/reference/google-cloud-asset-v1/0.23.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.22.0](/ruby/docs/reference/google-cloud-asset-v1/0.22.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.21.1](/ruby/docs/reference/google-cloud-asset-v1/0.21.1/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.20.1](/ruby/docs/reference/google-cloud-asset-v1/0.20.1/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.19.0](/ruby/docs/reference/google-cloud-asset-v1/0.19.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.18.0](/ruby/docs/reference/google-cloud-asset-v1/0.18.0/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy)\n- [0.17.3](/ruby/docs/reference/google-cloud-asset-v1/0.17.3/Google-Cloud-OrgPolicy-V1-Policy-BooleanPolicy) \nReference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::OrgPolicy::V1::Policy::BooleanPolicy.\n\nUsed in `policy_type` to specify how `boolean_policy` will behave at this\nresource. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #enforced\n\n def enforced() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable.\n\n\n Suppose you have a `Constraint`\n `constraints/compute.disableSerialPortAccess` with `constraint_default`\n set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following\n behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource.\n\n The following examples demonstrate the different possible layerings:\n\n Example 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\n The constraint at `projects/bar` and `organizations/foo` will not be\n enforced.\n\n Example 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\n The constraint at `organizations/foo` is not enforced.\n The constraint at `projects/bar` is enforced.\n\n Example 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: \\\\{}}\n The constraint at `organizations/foo` is enforced.\n The constraint at `projects/bar` is not enforced, because\n `constraint_default` for the `Constraint` is `ALLOW`.\n\n### #enforced=\n\n def enforced=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable.\n\n\n Suppose you have a `Constraint`\n `constraints/compute.disableSerialPortAccess` with `constraint_default`\n set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following\n behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource.\n\n The following examples demonstrate the different possible layerings:\n\n Example 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\n The constraint at `projects/bar` and `organizations/foo` will not be\n enforced.\n\n Example 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\n The constraint at `organizations/foo` is not enforced.\n The constraint at `projects/bar` is enforced.\n\n Example 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: \\\\{}}\n The constraint at `organizations/foo` is enforced.\n The constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`. \n**Returns**\n\n- (::Boolean) --- If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable.\n\n\n Suppose you have a `Constraint`\n `constraints/compute.disableSerialPortAccess` with `constraint_default`\n set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following\n behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource.\n\n The following examples demonstrate the different possible layerings:\n\n Example 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\n The constraint at `projects/bar` and `organizations/foo` will not be\n enforced.\n\n Example 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\n The constraint at `organizations/foo` is not enforced.\n The constraint at `projects/bar` is enforced.\n\n Example 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: \\\\{}}\n The constraint at `organizations/foo` is enforced.\n The constraint at `projects/bar` is not enforced, because\n `constraint_default` for the `Constraint` is `ALLOW`."]]
