Cloud OS Config V1alpha API - Class Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance (v0.3.0)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Cloud OS Config V1alpha API class Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance.

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.


  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods


  • Google::Protobuf::MessageExts



def detailed_state() -> ::String
  • (::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.


def detailed_state_reason() -> ::String
  • (::String) — Output only. The reason for the detailed_state of the VM (if any).


def instance() -> ::String
  • (::String) — Output only. The Compute Engine VM instance name.


def last_compliance_check_time() -> ::Google::Protobuf::Timestamp


def last_compliance_run_id() -> ::String
  • (::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.


def name() -> ::String
  • (::String) — Output only. The InstanceOSPoliciesCompliance API resource name.

    Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}


def os_policy_compliances() -> ::Array<::Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance::OSPolicyCompliance>


def state() -> ::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState