Class OSPolicyAssignmentReport.OSPolicyCompliance (2.4.3)

public static final class OSPolicyAssignmentReport.OSPolicyCompliance extends GeneratedMessageV3 implements OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder

Compliance data for an OS policy

Protobuf type google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OSPolicyAssignmentReport.OSPolicyCompliance

Static Fields

COMPLIANCE_STATE_FIELD_NUMBER

public static final int COMPLIANCE_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

COMPLIANCE_STATE_REASON_FIELD_NUMBER

public static final int COMPLIANCE_STATE_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

OS_POLICY_ID_FIELD_NUMBER

public static final int OS_POLICY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

OS_POLICY_RESOURCE_COMPLIANCES_FIELD_NUMBER

public static final int OS_POLICY_RESOURCE_COMPLIANCES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OSPolicyAssignmentReport.OSPolicyCompliance getDefaultInstance()
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static OSPolicyAssignmentReport.OSPolicyCompliance.Builder newBuilder()
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

newBuilder(OSPolicyAssignmentReport.OSPolicyCompliance prototype)

public static OSPolicyAssignmentReport.OSPolicyCompliance.Builder newBuilder(OSPolicyAssignmentReport.OSPolicyCompliance prototype)
Parameter
NameDescription
prototypeOSPolicyAssignmentReport.OSPolicyCompliance
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

parseDelimitedFrom(InputStream input)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OSPolicyAssignmentReport.OSPolicyCompliance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OSPolicyAssignmentReport.OSPolicyCompliance> parser()
Returns
TypeDescription
Parser<OSPolicyCompliance>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getComplianceState()

public 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 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 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 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.

getDefaultInstanceForType()

public OSPolicyAssignmentReport.OSPolicyCompliance getDefaultInstanceForType()
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance

getOsPolicyId()

public String getOsPolicyId()

The OS policy id

string os_policy_id = 1;

Returns
TypeDescription
String

The osPolicyId.

getOsPolicyIdBytes()

public ByteString getOsPolicyIdBytes()

The OS policy id

string os_policy_id = 1;

Returns
TypeDescription
ByteString

The bytes for osPolicyId.

getOsPolicyResourceCompliances(int index)

public 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 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 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 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 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>

getParserForType()

public Parser<OSPolicyAssignmentReport.OSPolicyCompliance> getParserForType()
Returns
TypeDescription
Parser<OSPolicyCompliance>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription