com.google.cloud.osconfig.v1alpha

Interface OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OSPolicyAssignmentReport.OSPolicyCompliance, OSPolicyAssignmentReport.OSPolicyCompliance.Builder

Enclosing class:

OSPolicyAssignmentReport

public static interface OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState	getComplianceState() The compliance state of the OS policy.
String	getComplianceStateReason() The reason for the OS policy to be in an unknown compliance state.
com.google.protobuf.ByteString	getComplianceStateReasonBytes() The reason for the OS policy to be in an unknown compliance state.
int	getComplianceStateValue() The compliance state of the OS policy.
String	getOsPolicyId() The OS policy id
com.google.protobuf.ByteString	getOsPolicyIdBytes() The OS policy id
OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance	getOsPolicyResourceCompliances(int index) Compliance data for each resource within the policy that is applied to the VM.
int	getOsPolicyResourceCompliancesCount() Compliance data for each resource within the policy that is applied to the VM.
List<OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance>	getOsPolicyResourceCompliancesList() Compliance data for each resource within the policy that is applied to the VM.
OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder	getOsPolicyResourceCompliancesOrBuilder(int index) Compliance data for each resource within the policy that is applied to the VM.
List<? extends OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder>	getOsPolicyResourceCompliancesOrBuilderList() Compliance data for each resource within the policy that is applied to the VM.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getOsPolicyId

String getOsPolicyId()

 The OS policy id
 

string os_policy_id = 1;

Returns:

The osPolicyId.

getOsPolicyIdBytes

com.google.protobuf.ByteString getOsPolicyIdBytes()

 The OS policy id
 

string os_policy_id = 1;

Returns:

The bytes for osPolicyId.

getComplianceStateValue

int getComplianceStateValue()

 The compliance state of the OS policy.
 

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

Returns:

The enum numeric value on the wire for complianceState.

getComplianceState

OSPolicyAssignmentReport.OSPolicyCompliance.ComplianceState getComplianceState()

 The compliance state of the OS policy.
 

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

Returns:

The complianceState.

getComplianceStateReason

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:

The complianceStateReason.

getComplianceStateReasonBytes

com.google.protobuf.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:

The bytes for complianceStateReason.

getOsPolicyResourceCompliancesList

List<OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance> getOsPolicyResourceCompliancesList()

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

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

getOsPolicyResourceCompliances

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance getOsPolicyResourceCompliances(int index)

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

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

getOsPolicyResourceCompliancesCount

int getOsPolicyResourceCompliancesCount()

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

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

getOsPolicyResourceCompliancesOrBuilderList

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

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

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

getOsPolicyResourceCompliancesOrBuilder

OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceComplianceOrBuilder getOsPolicyResourceCompliancesOrBuilder(int index)

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

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