Interface OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder (2.19.0)

public static interface OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getComplianceState()

public abstract OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState getComplianceState()

The compliance state of the OS policy.

.google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState compliance_state = 2;

Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState

The complianceState.

getComplianceStateReason()

public abstract String getComplianceStateReason()

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.

string compliance_state_reason = 3;

Returns
TypeDescription
String

The complianceStateReason.

getComplianceStateReasonBytes()

public abstract ByteString getComplianceStateReasonBytes()

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.

string compliance_state_reason = 3;

Returns
TypeDescription
ByteString

The bytes for complianceStateReason.

getComplianceStateValue()

public abstract int getComplianceStateValue()

The compliance state of the OS policy.

.google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState compliance_state = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for complianceState.

getOsPolicyId()

public abstract String getOsPolicyId()

The OS policy id

string os_policy_id = 1;

Returns
TypeDescription
String

The osPolicyId.

getOsPolicyIdBytes()

public abstract ByteString getOsPolicyIdBytes()

The OS policy id

string os_policy_id = 1;

Returns
TypeDescription
ByteString

The bytes for osPolicyId.

getOsPolicyResourceCompliances(int index)

public abstract OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance getOsPolicyResourceCompliances(int index)

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

repeated .google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance os_policy_resource_compliances = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

getOsPolicyResourceCompliancesCount()

public abstract int getOsPolicyResourceCompliancesCount()

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

repeated .google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance os_policy_resource_compliances = 4;

Returns
TypeDescription
int

getOsPolicyResourceCompliancesList()

public abstract List<OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance> getOsPolicyResourceCompliancesList()

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

repeated .google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance os_policy_resource_compliances = 4;

Returns
TypeDescription
List<OSPolicyResourceCompliance>

getOsPolicyResourceCompliancesOrBuilder(int index)

public abstract OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder getOsPolicyResourceCompliancesOrBuilder(int index)

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

repeated .google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance os_policy_resource_compliances = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder

getOsPolicyResourceCompliancesOrBuilderList()

public abstract List<? extends OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder> getOsPolicyResourceCompliancesOrBuilderList()

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

repeated .google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance os_policy_resource_compliances = 4;

Returns
TypeDescription
List<? extends com.google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder>