Class: Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/policysimulator_v1alpha/classes.rb,
lib/google/apis/policysimulator_v1alpha/representations.rb,
lib/google/apis/policysimulator_v1alpha/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.



788
789
790
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 788

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

Instance Attribute Details

#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) 


760
761
762
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 760

def name
  @name
end

#overlay ⇒ Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay

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

Returns:



765
766
767
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 765

def overlay
  @overlay
end

#resource_counts ⇒ Google::Apis::PolicysimulatorV1alpha::GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts

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

Returns:



771
772
773
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 771

def resource_counts
  @resource_counts
end

#state ⇒ String

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

Returns:

  • (String) 


776
777
778
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 776

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) 


786
787
788
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 786

def violations_count
  @violations_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



793
794
795
796
797
798
799
 
# File 'lib/google/apis/policysimulator_v1alpha/classes.rb', line 793

def update!(**args)
  @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