Class InstanceOSPoliciesCompliance (2.11.0)

public final class InstanceOSPoliciesCompliance extends GeneratedMessageV3 implements InstanceOSPoliciesComplianceOrBuilder

This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see View compliance.

Protobuf type google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceOSPoliciesCompliance

Implements

InstanceOSPoliciesComplianceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DETAILED_STATE_FIELD_NUMBER

public static final int DETAILED_STATE_FIELD_NUMBER

Field Value

Type	Description
`int`

DETAILED_STATE_REASON_FIELD_NUMBER

public static final int DETAILED_STATE_REASON_FIELD_NUMBER

Field Value

Type	Description
`int`

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER

Field Value

Type	Description
`int`

LAST_COMPLIANCE_CHECK_TIME_FIELD_NUMBER

public static final int LAST_COMPLIANCE_CHECK_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

LAST_COMPLIANCE_RUN_ID_FIELD_NUMBER

public static final int LAST_COMPLIANCE_RUN_ID_FIELD_NUMBER

Field Value

Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
`int`

OS_POLICY_COMPLIANCES_FIELD_NUMBER

public static final int OS_POLICY_COMPLIANCES_FIELD_NUMBER

Field Value

Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value

Type	Description
`int`

Static Methods

getDefaultInstance()

public static InstanceOSPoliciesCompliance getDefaultInstance()

Returns

Type	Description
`InstanceOSPoliciesCompliance`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

newBuilder()

public static InstanceOSPoliciesCompliance.Builder newBuilder()

Returns

Type	Description
`InstanceOSPoliciesCompliance.Builder`

newBuilder(InstanceOSPoliciesCompliance prototype)

public static InstanceOSPoliciesCompliance.Builder newBuilder(InstanceOSPoliciesCompliance prototype)

Parameter

Name	Description
`prototype`	`InstanceOSPoliciesCompliance`

Returns

Type	Description
`InstanceOSPoliciesCompliance.Builder`

parseDelimitedFrom(InputStream input)

public static InstanceOSPoliciesCompliance parseDelimitedFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseFrom(byte[] data)

public static InstanceOSPoliciesCompliance parseFrom(byte[] data)

Parameter

Name	Description
`data`	`byte[]`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static InstanceOSPoliciesCompliance parseFrom(ByteString data)

Parameter

Name	Description
`data`	`ByteString`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static InstanceOSPoliciesCompliance parseFrom(CodedInputStream input)

Parameter

Name	Description
`input`	`CodedInputStream`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input)

public static InstanceOSPoliciesCompliance parseFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static InstanceOSPoliciesCompliance parseFrom(ByteBuffer data)

Parameter

Name	Description
`data`	`ByteBuffer`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceOSPoliciesCompliance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`InstanceOSPoliciesCompliance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<InstanceOSPoliciesCompliance> parser()

Returns

Type	Description
`Parser<InstanceOSPoliciesCompliance>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
`obj`	`Object`

Returns

Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public InstanceOSPoliciesCompliance getDefaultInstanceForType()

Returns

Type	Description
`InstanceOSPoliciesCompliance`

getDetailedState()

public String getDetailedState()

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN. It may contain one of the following values:

no-compliance-data: Compliance data is not available for this VM.
no-agent-detected: OS Config agent is not detected for this VM.
config-not-supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management.
inactive: VM is not running.
internal-service-errors: There were internal service errors encountered while enforcing compliance.
agent-errors: OS config agent encountered errors while enforcing compliance.

string detailed_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The detailedState.

getDetailedStateBytes()

public ByteString getDetailedStateBytes()

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN. It may contain one of the following values:

no-compliance-data: Compliance data is not available for this VM.
no-agent-detected: OS Config agent is not detected for this VM.
config-not-supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management.
inactive: VM is not running.
internal-service-errors: There were internal service errors encountered while enforcing compliance.
agent-errors: OS config agent encountered errors while enforcing compliance.

string detailed_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for detailedState.

getDetailedStateReason()

public String getDetailedStateReason()

Output only. The reason for the detailed_state of the VM (if any).

string detailed_state_reason = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The detailedStateReason.

getDetailedStateReasonBytes()

public ByteString getDetailedStateReasonBytes()

Output only. The reason for the detailed_state of the VM (if any).

string detailed_state_reason = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for detailedStateReason.

getInstance()

public String getInstance()

Output only. The Compute Engine VM instance name.

string instance = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

Output only. The Compute Engine VM instance name.

string instance = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for instance.

getLastComplianceCheckTime()

public Timestamp getLastComplianceCheckTime()

Output only. Timestamp of the last compliance check for the VM.

.google.protobuf.Timestamp last_compliance_check_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The lastComplianceCheckTime.

getLastComplianceCheckTimeOrBuilder()

public TimestampOrBuilder getLastComplianceCheckTimeOrBuilder()

Output only. Timestamp of the last compliance check for the VM.

.google.protobuf.Timestamp last_compliance_check_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getLastComplianceRunId()

public String getLastComplianceRunId()

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.

string last_compliance_run_id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The lastComplianceRunId.

getLastComplianceRunIdBytes()

public ByteString getLastComplianceRunIdBytes()

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.

string last_compliance_run_id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for lastComplianceRunId.

getName()

public String getName()

Output only. The InstanceOSPoliciesCompliance API resource name. Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The InstanceOSPoliciesCompliance API resource name. Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`ByteString`	The bytes for name.

getOsPolicyCompliances(int index)

public InstanceOSPoliciesCompliance.OSPolicyCompliance getOsPolicyCompliances(int index)

Output only. Compliance data for each OSPolicy that is applied to the VM.

repeated .google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance os_policy_compliances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`InstanceOSPoliciesCompliance.OSPolicyCompliance`

getOsPolicyCompliancesCount()

public int getOsPolicyCompliancesCount()

Output only. Compliance data for each OSPolicy that is applied to the VM.

repeated .google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance os_policy_compliances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`int`

getOsPolicyCompliancesList()

public List<InstanceOSPoliciesCompliance.OSPolicyCompliance> getOsPolicyCompliancesList()

Output only. Compliance data for each OSPolicy that is applied to the VM.

repeated .google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance os_policy_compliances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`List<OSPolicyCompliance>`

getOsPolicyCompliancesOrBuilder(int index)

public InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder getOsPolicyCompliancesOrBuilder(int index)

Output only. Compliance data for each OSPolicy that is applied to the VM.

repeated .google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance os_policy_compliances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder`

getOsPolicyCompliancesOrBuilderList()

public List<? extends InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder> getOsPolicyCompliancesOrBuilderList()

Output only. Compliance data for each OSPolicy that is applied to the VM.

repeated .google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance os_policy_compliances = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`List<? extends com.google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder>`

getParserForType()

public Parser<InstanceOSPoliciesCompliance> getParserForType()

Returns

Type	Description
`Parser<InstanceOSPoliciesCompliance>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public OSPolicyComplianceState getState()

Output only. Compliance state of the VM.

.google.cloud.osconfig.v1alpha.OSPolicyComplianceState state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`OSPolicyComplianceState`	The state.

getStateValue()

public int getStateValue()

Output only. Compliance state of the VM.

.google.cloud.osconfig.v1alpha.OSPolicyComplianceState state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`int`	The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

hasLastComplianceCheckTime()

public boolean hasLastComplianceCheckTime()

Output only. Timestamp of the last compliance check for the VM.

.google.protobuf.Timestamp last_compliance_check_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the lastComplianceCheckTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public InstanceOSPoliciesCompliance.Builder newBuilderForType()

Returns

Type	Description
`InstanceOSPoliciesCompliance.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceOSPoliciesCompliance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
`parent`	`BuilderParent`

Returns

Type	Description
`InstanceOSPoliciesCompliance.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
`unused`	`UnusedPrivateParameter`

Returns

Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public InstanceOSPoliciesCompliance.Builder toBuilder()

Returns

Type	Description
`InstanceOSPoliciesCompliance.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
`IOException`