Reference documentation and code samples for the Policy Simulator V1 API class Google::Cloud::OrgPolicy::V2::PolicySpec.
Defines a Google Cloud policy specification which is used to specify
constraints for configurations of Google Cloud resources.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#etag
defetag()->::String
Returns
(::String) — An opaque tag indicating the current version of the policySpec, used for
concurrency control.
This field is ignored if used in a CreatePolicy request.
When the policy is returned from either a GetPolicy or a
ListPolicies request, this etag indicates the version of the
current policySpec to use when executing a read-modify-write loop.
When the policy is returned from a GetEffectivePolicy request, the
etag will be unset.
#etag=
defetag=(value)->::String
Parameter
value (::String) — An opaque tag indicating the current version of the policySpec, used for
concurrency control.
This field is ignored if used in a CreatePolicy request.
When the policy is returned from either a GetPolicy or a
ListPolicies request, this etag indicates the version of the
current policySpec to use when executing a read-modify-write loop.
When the policy is returned from a GetEffectivePolicy request, the
etag will be unset.
Returns
(::String) — An opaque tag indicating the current version of the policySpec, used for
concurrency control.
This field is ignored if used in a CreatePolicy request.
When the policy is returned from either a GetPolicy or a
ListPolicies request, this etag indicates the version of the
current policySpec to use when executing a read-modify-write loop.
When the policy is returned from a GetEffectivePolicy request, the
etag will be unset.
#inherit_from_parent
definherit_from_parent()->::Boolean
Returns
(::Boolean) — Determines the inheritance behavior for this policy.
If inherit_from_parent is true, policy rules set higher up in the
hierarchy (up to the closest root) are inherited and present in the
effective policy. If it is false, then no rules are inherited, and this
policy becomes the new root for evaluation.
This field can be set only for policies which configure list constraints.
#inherit_from_parent=
definherit_from_parent=(value)->::Boolean
Parameter
value (::Boolean) — Determines the inheritance behavior for this policy.
If inherit_from_parent is true, policy rules set higher up in the
hierarchy (up to the closest root) are inherited and present in the
effective policy. If it is false, then no rules are inherited, and this
policy becomes the new root for evaluation.
This field can be set only for policies which configure list constraints.
Returns
(::Boolean) — Determines the inheritance behavior for this policy.
If inherit_from_parent is true, policy rules set higher up in the
hierarchy (up to the closest root) are inherited and present in the
effective policy. If it is false, then no rules are inherited, and this
policy becomes the new root for evaluation.
This field can be set only for policies which configure list constraints.
#reset
defreset()->::Boolean
Returns
(::Boolean) — Ignores policies set above this resource and restores the
constraint_default enforcement behavior of the specific constraint at
this resource.
This field can be set in policies for either list or boolean
constraints. If set, rules must be empty and inherit_from_parent
must be set to false.
#reset=
defreset=(value)->::Boolean
Parameter
value (::Boolean) — Ignores policies set above this resource and restores the
constraint_default enforcement behavior of the specific constraint at
this resource.
This field can be set in policies for either list or boolean
constraints. If set, rules must be empty and inherit_from_parent
must be set to false.
Returns
(::Boolean) — Ignores policies set above this resource and restores the
constraint_default enforcement behavior of the specific constraint at
this resource.
This field can be set in policies for either list or boolean
constraints. If set, rules must be empty and inherit_from_parent
must be set to false.
In policies for boolean constraints, the following requirements apply:
There must be one and only one policy rule where condition is unset.
Boolean policy rules with conditions must set enforced to the
opposite of the policy rule without a condition.
During policy evaluation, policy rules with conditions that are
true for a target resource take precedence.
#update_time
defupdate_time()->::Google::Protobuf::Timestamp
Returns
(::Google::Protobuf::Timestamp) — Output only. The time stamp this was previously updated. This
represents the last time a call to CreatePolicy or UpdatePolicy was
made for that policy.
[[["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-03 UTC."],[],[],null,["# Policy Simulator V1 API - Class Google::Cloud::OrgPolicy::V2::PolicySpec (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-policy_simulator-v1/latest/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [1.3.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.3.0/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [1.2.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.2.1/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [1.1.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.1.0/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [1.0.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.0.1/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [0.4.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.4.0/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [0.3.2](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.3.2/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [0.2.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.2.0/Google-Cloud-OrgPolicy-V2-PolicySpec)\n- [0.1.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.1.1/Google-Cloud-OrgPolicy-V2-PolicySpec) \nReference documentation and code samples for the Policy Simulator V1 API class Google::Cloud::OrgPolicy::V2::PolicySpec.\n\nDefines a Google Cloud policy specification which is used to specify\nconstraints for configurations of Google Cloud resources. \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### #etag\n\n def etag() -\u003e ::String\n\n**Returns**\n\n- (::String) --- An opaque tag indicating the current version of the policySpec, used for concurrency control.\n\n This field is ignored if used in a `CreatePolicy` request.\n\n When the policy is returned from either a `GetPolicy` or a\n `ListPolicies` request, this `etag` indicates the version of the\n current policySpec to use when executing a read-modify-write loop.\n\n When the policy is returned from a `GetEffectivePolicy` request, the\n `etag` will be unset.\n\n### #etag=\n\n def etag=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- An opaque tag indicating the current version of the policySpec, used for concurrency control.\n\n\n This field is ignored if used in a `CreatePolicy` request.\n\n When the policy is returned from either a `GetPolicy` or a\n `ListPolicies` request, this `etag` indicates the version of the\n current policySpec to use when executing a read-modify-write loop.\n\n When the policy is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset. \n**Returns**\n\n- (::String) --- An opaque tag indicating the current version of the policySpec, used for concurrency control.\n\n This field is ignored if used in a `CreatePolicy` request.\n\n When the policy is returned from either a `GetPolicy` or a\n `ListPolicies` request, this `etag` indicates the version of the\n current policySpec to use when executing a read-modify-write loop.\n\n When the policy is returned from a `GetEffectivePolicy` request, the\n `etag` will be unset.\n\n### #inherit_from_parent\n\n def inherit_from_parent() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Determines the inheritance behavior for this policy.\n\n If `inherit_from_parent` is true, policy rules set higher up in the\n hierarchy (up to the closest root) are inherited and present in the\n effective policy. If it is false, then no rules are inherited, and this\n policy becomes the new root for evaluation.\n This field can be set only for policies which configure list constraints.\n\n### #inherit_from_parent=\n\n def inherit_from_parent=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Determines the inheritance behavior for this policy.\n\n\n If `inherit_from_parent` is true, policy rules set higher up in the\n hierarchy (up to the closest root) are inherited and present in the\n effective policy. If it is false, then no rules are inherited, and this\n policy becomes the new root for evaluation.\nThis field can be set only for policies which configure list constraints. \n**Returns**\n\n- (::Boolean) --- Determines the inheritance behavior for this policy.\n\n If `inherit_from_parent` is true, policy rules set higher up in the\n hierarchy (up to the closest root) are inherited and present in the\n effective policy. If it is false, then no rules are inherited, and this\n policy becomes the new root for evaluation.\n This field can be set only for policies which configure list constraints.\n\n### #reset\n\n def reset() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.\n\n### #reset=\n\n def reset=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. \n**Returns**\n\n- (::Boolean) --- Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false.\n\n### #rules\n\n def rules() -\u003e ::Array\u003c::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule](./Google-Cloud-OrgPolicy-V2-PolicySpec-PolicyRule)\\\u003e) ---\n\n In policies for boolean constraints, the following requirements apply:\n - There must be one and only one policy rule where condition is unset.\n - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition.\n - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.\n\n### #rules=\n\n def rules=(value) -\u003e ::Array\u003c::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule](./Google-Cloud-OrgPolicy-V2-PolicySpec-PolicyRule)\\\u003e) ---\n\n In policies for boolean constraints, the following requirements apply:\n - There must be one and only one policy rule where condition is unset.\n - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition.\n- During policy evaluation, policy rules with conditions that are true for a target resource take precedence. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule](./Google-Cloud-OrgPolicy-V2-PolicySpec-PolicyRule)\\\u003e) ---\n\n In policies for boolean constraints, the following requirements apply:\n - There must be one and only one policy rule where condition is unset.\n - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition.\n - During policy evaluation, policy rules with conditions that are true for a target resource take precedence.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy."]]
