Class: Google::Apis::OrgpolicyV2::GoogleCloudOrgpolicyV2CustomConstraint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/orgpolicy_v2/classes.rb,
lib/google/apis/orgpolicy_v2/representations.rb,
lib/google/apis/orgpolicy_v2/representations.rb

Overview

A custom constraint defined by customers which can only be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudOrgpolicyV2CustomConstraint

Returns a new instance of GoogleCloudOrgpolicyV2CustomConstraint.



354
355
356
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 354

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action_type ⇒ String

Allow or deny type. Corresponds to the JSON property actionType

Returns:

  • (String) 


305
306
307
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 305

def action_type
  @action_type
end

#condition ⇒ 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. Corresponds to the JSON property condition

Returns:

  • (String) 


312
313
314
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 312

def condition
  @condition
end

#description ⇒ String

Detailed information about this custom policy constraint. The max length of the description is 2000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


318
319
320
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 318

def description
  @description
end

#display_name ⇒ String

One line display name for the UI. The max length of the display_name is 200 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


324
325
326
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 324

def display_name
  @display_name
end

#method_types ⇒ Array<String>

All the operations being applied for this constraint. Corresponds to the JSON property methodTypes

Returns:

  • (Array<String>) 


329
330
331
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 329

def method_types
  @method_types
end

#name ⇒ String

Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * organizations/organization_id/ customConstraints/custom_constraint_id`Example:organizations/123/ customConstraints/custom.createOnlyE2TypeVmsThe max length is 70 characters and the minimum length is 1. Note that the prefixorganizations/ organization_id/customConstraints/is not counted. Corresponds to the JSON propertyname`

Returns:

  • (String) 


339
340
341
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 339

def name
  @name
end

#resource_types ⇒ Array<String>

Immutable. The resource instance type on which this policy applies. Format will be of the form : / Example: * compute.googleapis.com/Instance. Corresponds to the JSON property resourceTypes

Returns:

  • (Array<String>) 


345
346
347
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 345

def resource_types
  @resource_types
end

#update_time ⇒ String

Output only. The last time this custom constraint was updated. This represents the last time that the CreateCustomConstraint or UpdateCustomConstraint RPC was called Corresponds to the JSON property updateTime

Returns:

  • (String) 


352
353
354
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 352

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/google/apis/orgpolicy_v2/classes.rb', line 359

def update!(**args)
  @action_type = args[:action_type] if args.key?(:action_type)
  @condition = args[:condition] if args.key?(:condition)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @method_types = args[:method_types] if args.key?(:method_types)
  @name = args[:name] if args.key?(:name)
  @resource_types = args[:resource_types] if args.key?(:resource_types)
  @update_time = args[:update_time] if args.key?(:update_time)
end