Cloud OS Config V1 API - Class Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance (v0.11.0)

Reference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance.

Compliance data for an OS policy

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#compliance_state

def compliance_state() -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::ComplianceState
Returns

#compliance_state=

def compliance_state=(value) -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::ComplianceState
Parameter
Returns

#compliance_state_reason

def compliance_state_reason() -> ::String
Returns
  • (::String) —

    The reason for the OS policy to be in an unknown compliance state. This field is always populated when compliance_state is UNKNOWN.

    If populated, the field can contain one of the following values:

    • vm-not-running: The VM was not running.
    • os-policies-not-supported-by-agent: The version of the OS Config agent running on the VM does not support running OS policies.
    • no-agent-detected: The OS Config agent is not detected for the VM.
    • resource-execution-errors: The OS Config agent encountered errors while executing one or more resources in the policy. See os_policy_resource_compliances for details.
    • task-timeout: The task sent to the agent to apply the policy timed out.
    • unexpected-agent-state: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies.
    • internal-service-errors: Internal service errors were encountered while attempting to apply the policy.

#compliance_state_reason=

def compliance_state_reason=(value) -> ::String
Parameter
  • value (::String) —

    The reason for the OS policy to be in an unknown compliance state. This field is always populated when compliance_state is UNKNOWN.

    If populated, the field can contain one of the following values:

    • vm-not-running: The VM was not running.
    • os-policies-not-supported-by-agent: The version of the OS Config agent running on the VM does not support running OS policies.
    • no-agent-detected: The OS Config agent is not detected for the VM.
    • resource-execution-errors: The OS Config agent encountered errors while executing one or more resources in the policy. See os_policy_resource_compliances for details.
    • task-timeout: The task sent to the agent to apply the policy timed out.
    • unexpected-agent-state: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies.
    • internal-service-errors: Internal service errors were encountered while attempting to apply the policy.
Returns
  • (::String) —

    The reason for the OS policy to be in an unknown compliance state. This field is always populated when compliance_state is UNKNOWN.

    If populated, the field can contain one of the following values:

    • vm-not-running: The VM was not running.
    • os-policies-not-supported-by-agent: The version of the OS Config agent running on the VM does not support running OS policies.
    • no-agent-detected: The OS Config agent is not detected for the VM.
    • resource-execution-errors: The OS Config agent encountered errors while executing one or more resources in the policy. See os_policy_resource_compliances for details.
    • task-timeout: The task sent to the agent to apply the policy timed out.
    • unexpected-agent-state: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies.
    • internal-service-errors: Internal service errors were encountered while attempting to apply the policy.

#os_policy_id

def os_policy_id() -> ::String
Returns
  • (::String) — The OS policy id

#os_policy_id=

def os_policy_id=(value) -> ::String
Parameter
  • value (::String) — The OS policy id
Returns
  • (::String) — The OS policy id

#os_policy_resource_compliances

def os_policy_resource_compliances() -> ::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance>
Returns

#os_policy_resource_compliances=

def os_policy_resource_compliances=(value) -> ::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance>
Parameter
Returns