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.



718
719
720
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 718

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) 


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

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


681
682
683
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 681

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) 


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

def name
  @name
end

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

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

Returns:



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

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:



701
702
703
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 701

def resource_counts
  @resource_counts
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


716
717
718
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 716

def violations_count
  @violations_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



723
724
725
726
727
728
729
730
731
 
# File 'lib/google/apis/policysimulator_v1beta/classes.rb', line 723

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