Class: Google::Apis::PolicysimulatorV1beta::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview

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

Overview

OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview

Returns a new instance of GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview.



706
707
708
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 706

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

Instance Attribute Details

#create_time ⇒ String

Output only. Time when this OrgPolicyViolationsPreview was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


658
659
660
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 658

def create_time
  @create_time
end

#custom_constraints ⇒ Array<String>

Output only. The names of the constraints against which all OrgPolicyViolations were evaluated. If OrgPolicyOverlay only contains PolicyOverlay then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in CustomConstraintOverlay. Format: organizations/ organization_id/customConstraints/custom_constraint_id`Example: organizations/123/customConstraints/custom.createOnlyE2TypeVms Corresponds to the JSON propertycustomConstraints`

Returns:

  • (Array<String>) 


669
670
671
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 669

def custom_constraints
  @custom_constraints
end

#name ⇒ String

Output only. The resource name of the OrgPolicyViolationsPreview. It has the following format: organizations/organization/locations/location/ orgPolicyViolationsPreviews/orgPolicyViolationsPreview`Example: organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/ 506a5f7f Corresponds to the JSON propertyname`

Returns:

  • (String) 


678
679
680
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 678

def name
  @name
end

#overlay ⇒ Google::Apis::PolicysimulatorV1beta::GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay

The proposed changes to OrgPolicy. Corresponds to the JSON property overlay

Returns:



683
684
685
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 683

def overlay
  @overlay
end

#resource_counts ⇒ Google::Apis::PolicysimulatorV1beta::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts

A summary of the state of all resources scanned for compliance with the changed OrgPolicy. Corresponds to the JSON property resourceCounts

Returns:



689
690
691
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 689

def resource_counts
  @resource_counts
end

#state ⇒ String

Output only. The state of the OrgPolicyViolationsPreview. Corresponds to the JSON property state

Returns:

  • (String) 


694
695
696
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 694

def state
  @state
end

#violations_count ⇒ Fixnum

Output only. The number of OrgPolicyViolations in this OrgPolicyViolationsPreview. This count may differ from resource_summary. noncompliant_count because each OrgPolicyViolation is specific to a resource * and* constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. Corresponds to the JSON property violationsCount

Returns:

  • (Fixnum) 


704
705
706
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 704

def violations_count
  @violations_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



711
712
713
714
715
716
717
718
719
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 711

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom_constraints = args[:custom_constraints] if args.key?(:custom_constraints)
  @name = args[:name] if args.key?(:name)
  @overlay = args[:overlay] if args.key?(:overlay)
  @resource_counts = args[:resource_counts] if args.key?(:resource_counts)
  @state = args[:state] if args.key?(:state)
  @violations_count = args[:violations_count] if args.key?(:violations_count)
end