Google Cloud OS Config v1 API - Class OSPolicyAssignmentReport.Types.OSPolicyCompliance (2.1.0)

public sealed class OSPolicyCompliance : IMessage<OSPolicyAssignmentReport.Types.OSPolicyCompliance>, IEquatable<OSPolicyAssignmentReport.Types.OSPolicyCompliance>, IDeepCloneable<OSPolicyAssignmentReport.Types.OSPolicyCompliance>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud OS Config v1 API class OSPolicyAssignmentReport.Types.OSPolicyCompliance.

Compliance data for an OS policy

Inheritance

Object > OSPolicyAssignmentReport.Types.OSPolicyCompliance

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

OSPolicyCompliance()

public OSPolicyCompliance()

OSPolicyCompliance(OSPolicyAssignmentReport.Types.OSPolicyCompliance)

public OSPolicyCompliance(OSPolicyAssignmentReport.Types.OSPolicyCompliance other)
Parameter
NameDescription
otherOSPolicyAssignmentReport.Types.OSPolicyCompliance

Properties

ComplianceState

public OSPolicyAssignmentReport.Types.OSPolicyCompliance.Types.ComplianceState ComplianceState { get; set; }

The compliance state of the OS policy.

Property Value
TypeDescription
OSPolicyAssignmentReport.Types.OSPolicyCompliance.Types.ComplianceState

ComplianceStateReason

public string ComplianceStateReason { get; set; }

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.
Property Value
TypeDescription
String

OsPolicyId

public string OsPolicyId { get; set; }

The OS policy id

Property Value
TypeDescription
String

OsPolicyResourceCompliances

public RepeatedField<OSPolicyAssignmentReport.Types.OSPolicyCompliance.Types.OSPolicyResourceCompliance> OsPolicyResourceCompliances { get; }

Compliance data for each resource within the policy that is applied to the VM.

Property Value
TypeDescription
RepeatedField<OSPolicyAssignmentReport.Types.OSPolicyCompliance.Types.OSPolicyResourceCompliance>