Class: Google::Apis::PolicysimulatorV1::GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview

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

Returns a new instance of GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview.



1407
1408
1409
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1407

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) 


1359
1360
1361
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1359

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


1370
1371
1372
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1370

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) 


1379
1380
1381
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1379

def name
  @name
end

#overlay ⇒ Google::Apis::PolicysimulatorV1::GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay

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

Returns:



1384
1385
1386
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1384

def overlay
  @overlay
end

#resource_counts ⇒ Google::Apis::PolicysimulatorV1::GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts

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

Returns:



1390
1391
1392
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1390

def resource_counts
  @resource_counts
end

#state ⇒ String

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

Returns:

  • (String) 


1395
1396
1397
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1395

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) 


1405
1406
1407
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1405

def violations_count
  @violations_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/google/apis/policysimulator_v1/classes.rb', line 1412

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