Class: Google::Apis::OsconfigV1alpha::InstanceOsPoliciesCompliance

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

Overview

This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see View compliance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceOsPoliciesCompliance

Returns a new instance of InstanceOsPoliciesCompliance.



323
324
325
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 323

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

Instance Attribute Details

#detailed_state ⇒ String

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN. It may contain one of the following values:

  • no-compliance-data: Compliance data is not available for this VM. * no- agent-detected: OS Config agent is not detected for this VM. * config-not- supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management. * inactive: VM is not running. * internal-service-errors: There were internal service errors encountered while enforcing compliance. * agent-errors: OS config agent encountered errors while enforcing compliance. Corresponds to the JSON property detailedState

Returns:

  • (String) 


282
283
284
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 282

def detailed_state
  @detailed_state
end

#detailed_state_reason ⇒ String

Output only. The reason for the detailed_state of the VM (if any). Corresponds to the JSON property detailedStateReason

Returns:

  • (String) 


287
288
289
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 287

def detailed_state_reason
  @detailed_state_reason
end

#instance ⇒ String

Output only. The Compute Engine VM instance name. Corresponds to the JSON property instance

Returns:

  • (String) 


292
293
294
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 292

def instance
  @instance
end

#last_compliance_check_time ⇒ String

Output only. Timestamp of the last compliance check for the VM. Corresponds to the JSON property lastComplianceCheckTime

Returns:

  • (String) 


297
298
299
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 297

def last_compliance_check_time
  @last_compliance_check_time
end

#last_compliance_run_id ⇒ String

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose. Corresponds to the JSON property lastComplianceRunId

Returns:

  • (String) 


304
305
306
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 304

def last_compliance_run_id
  @last_compliance_run_id
end

#name ⇒ String

Output only. The InstanceOSPoliciesCompliance API resource name. Format: projects/project_number/locations/location/instanceOSPoliciesCompliances/ instance_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


311
312
313
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 311

def name
  @name
end

#os_policy_compliances ⇒ Array<Google::Apis::OsconfigV1alpha::InstanceOsPoliciesComplianceOsPolicyCompliance>

Output only. Compliance data for each OSPolicy that is applied to the VM. Corresponds to the JSON property osPolicyCompliances

Returns:



316
317
318
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 316

def os_policy_compliances
  @os_policy_compliances
end

#state ⇒ String

Output only. Compliance state of the VM. Corresponds to the JSON property state

Returns:

  • (String) 


321
322
323
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 321

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/google/apis/osconfig_v1alpha/classes.rb', line 328

def update!(**args)
  @detailed_state = args[:detailed_state] if args.key?(:detailed_state)
  @detailed_state_reason = args[:detailed_state_reason] if args.key?(:detailed_state_reason)
  @instance = args[:instance] if args.key?(:instance)
  @last_compliance_check_time = args[:last_compliance_check_time] if args.key?(:last_compliance_check_time)
  @last_compliance_run_id = args[:last_compliance_run_id] if args.key?(:last_compliance_run_id)
  @name = args[:name] if args.key?(:name)
  @os_policy_compliances = args[:os_policy_compliances] if args.key?(:os_policy_compliances)
  @state = args[:state] if args.key?(:state)
end