Class: Google::Cloud::OrgPolicy::V2::Constraint
- Inherits:
-
Object
- Object
- Google::Cloud::OrgPolicy::V2::Constraint
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/orgpolicy/v2/constraint.rb
Overview
A constraint describes a way to restrict resource's configuration. For
example, you could enforce a constraint that controls which Google Cloud
services can be activated across an organization, or whether a Compute Engine
instance can have serial port connections established. Constraints can be
configured by the organization policy administrator to fit the needs of the
organization by setting a policy that includes constraints at different
locations in the organization's resource hierarchy. Policies are inherited
down the resource hierarchy from higher levels, but can also be overridden.
For details about the inheritance rules, see
Policy.
Constraints have a default behavior determined by the constraint_default
field, which is the enforcement behavior that is used in the absence of a
policy being defined or inherited for the resource in question.
Defined Under Namespace
Modules: ConstraintDefault Classes: BooleanConstraint, CustomConstraintDefinition, ListConstraint
Instance Attribute Summary collapse
-
#boolean_constraint ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint
Defines this constraint as being a boolean constraint.
-
#constraint_default ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault
The evaluation behavior of this constraint in the absence of a policy.
-
#description ⇒ ::String
Detailed description of what this constraint controls as well as how and where it is enforced.
-
#display_name ⇒ ::String
The human readable name.
-
#equivalent_constraint ⇒ ::String
Managed constraint and canned constraint sometimes can have equivalents.
-
#list_constraint ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint
Defines this constraint as being a list constraint.
-
#name ⇒ ::String
Immutable.
-
#supports_dry_run ⇒ ::Boolean
Shows if dry run is supported for this constraint or not.
-
#supports_simulation ⇒ ::Boolean
Shows if simulation is supported for this constraint or not.
Instance Attribute Details
#boolean_constraint ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint
Returns Defines this constraint as being a boolean constraint.
Note: The following fields are mutually exclusive: boolean_constraint, list_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#constraint_default ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault
Returns The evaluation behavior of this constraint in the absence of a policy.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#description ⇒ ::String
Returns Detailed description of what this constraint controls as well as how and where it is enforced.
Mutable.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#display_name ⇒ ::String
Returns The human readable name.
Mutable.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#equivalent_constraint ⇒ ::String
Returns Managed constraint and canned constraint sometimes can have equivalents. This field is used to store the equivalent constraint name.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#list_constraint ⇒ ::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint
Returns Defines this constraint as being a list constraint.
Note: The following fields are mutually exclusive: list_constraint, boolean_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#name ⇒ ::String
Returns Immutable. The resource name of the constraint. Must be in one of the following forms:
projects/{project_number}/constraints/{constraint_name}folders/{folder_id}/constraints/{constraint_name}organizations/{organization_id}/constraints/{constraint_name}
For example, "/projects/123/constraints/compute.disableSerialPortAccess".
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#supports_dry_run ⇒ ::Boolean
Returns Shows if dry run is supported for this constraint or not.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |
#supports_simulation ⇒ ::Boolean
Returns Shows if simulation is supported for this constraint or not.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'proto_docs/google/cloud/orgpolicy/v2/constraint.rb', line 82 class Constraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A constraint type that allows or disallows a list of string values, which # are configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # @!attribute [rw] supports_in # @return [::Boolean] # Indicates whether values grouped into categories can be used in # `Policy.allowed_values` and `Policy.denied_values`. For example, # `"in:Python"` would match any value in the 'Python' group. # @!attribute [rw] supports_under # @return [::Boolean] # Indicates whether subtrees of the Resource Manager resource hierarchy # can be used in `Policy.allowed_values` and `Policy.denied_values`. For # example, `"under:folders/123"` would match any resource under the # 'folders/123' folder. class ListConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom constraint definition. Defines this as a managed constraint. # @!attribute [rw] resource_types # @return [::Array<::String>] # The resource instance type on which this policy applies. Format will be # of the form : `<service name>/<type>` Example: # # * `compute.googleapis.com/Instance`. # @!attribute [rw] method_types # @return [::Array<::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::MethodType>] # All the operations being applied for this constraint. # @!attribute [rw] condition # @return [::String] # Org policy condition/expression. For example: # `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, # `resource.management.auto_upgrade == true` # # The max length of the condition is 1000 characters. # @!attribute [rw] action_type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::ActionType] # Allow or deny type. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter}] # Stores the structure of # {::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter `Parameters`} # used by the constraint condition. The key of `map` represents the name of # the parameter. class CustomConstraintDefinition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines a parameter structure. # @!attribute [rw] type # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Type of the parameter. # @!attribute [rw] default_value # @return [::Google::Protobuf::Value] # Sets the value of the parameter in an assignment if no value is given. # @!attribute [rw] valid_values_expr # @return [::String] # Provides a CEL expression to specify the acceptable parameter values # during assignment. # For example, parameterName in ("parameterValue1", "parameterValue2") # @!attribute [rw] metadata # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Metadata] # Defines subproperties primarily used by the UI to display user-friendly # information. # @!attribute [rw] item # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter::Type] # Determines the parameter's value structure. # For example, `LIST<STRING>` can be specified by defining `type: LIST`, # and `item: STRING`. class Parameter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Defines Metadata structure. # @!attribute [rw] description # @return [::String] # Detailed description of what this `parameter` is and use of it. # Mutable. class Metadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # All valid types of parameter. module Type # This is only used for distinguishing unset values and should never be # used. Results in an error. TYPE_UNSPECIFIED = 0 # List parameter type. LIST = 1 # String parameter type. STRING = 2 # Boolean parameter type. BOOLEAN = 3 end end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition::Parameter] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The operation for which this constraint will be applied. To apply this # constraint only when creating new resources, the `method_types` should be # `CREATE` only. To apply this constraint when creating or deleting # resources, the `method_types` should be `CREATE` and `DELETE`. # # `UPDATE`-only custom constraints are not supported. Use `CREATE` or # `CREATE, UPDATE`. module MethodType # This is only used for distinguishing unset values and should never be # used. Results in an error. METHOD_TYPE_UNSPECIFIED = 0 # Constraint applied when creating the resource. CREATE = 1 # Constraint applied when updating the resource. UPDATE = 2 # Constraint applied when deleting the resource. # Not currently supported. DELETE = 3 # Constraint applied when removing an IAM grant. REMOVE_GRANT = 4 # Constraint applied when enforcing forced tagging. GOVERN_TAGS = 5 end # Allow or deny type. module ActionType # This is only used for distinguishing unset values and should never be # used. Results in an error. ACTION_TYPE_UNSPECIFIED = 0 # Allowed action type. ALLOW = 1 # Deny action type. DENY = 2 end end # A constraint type is enforced or not enforced, which is configured in the # {::Google::Cloud::OrgPolicy::V2::PolicySpec::PolicyRule `PolicyRule`}. # # If `customConstraintDefinition` is defined, this constraint is a managed # constraint. # @!attribute [rw] custom_constraint_definition # @return [::Google::Cloud::OrgPolicy::V2::Constraint::CustomConstraintDefinition] # Custom constraint definition. Defines this as a managed constraint. class BooleanConstraint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specifies the default behavior in the absence of any policy for the # constraint. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`. # # Immutable after creation. module ConstraintDefault # This is only used for distinguishing unset values and should never be # used. Results in an error. CONSTRAINT_DEFAULT_UNSPECIFIED = 0 # Indicate that all values are allowed for list constraints. # Indicate that enforcement is off for boolean constraints. ALLOW = 1 # Indicate that all values are denied for list constraints. # Indicate that enforcement is on for boolean constraints. DENY = 2 end end |