Class InstanceOSPoliciesCompliance.Builder (2.5.1)

public static final class InstanceOSPoliciesCompliance.Builder extends GeneratedMessageV3.Builder<InstanceOSPoliciesCompliance.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllOsPolicyCompliances(Iterable<? extends InstanceOSPoliciesCompliance.OSPolicyCompliance> values)

public InstanceOSPoliciesCompliance.Builder addAllOsPolicyCompliances(Iterable<? extends InstanceOSPoliciesCompliance.OSPolicyCompliance> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.osconfig.v1alpha.InstanceOSPoliciesCompliance.OSPolicyCompliance>
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

addOsPolicyCompliances(InstanceOSPoliciesCompliance.OSPolicyCompliance value)

public InstanceOSPoliciesCompliance.Builder addOsPolicyCompliances(InstanceOSPoliciesCompliance.OSPolicyCompliance value)

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
NameDescription
valueInstanceOSPoliciesCompliance.OSPolicyCompliance
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

addOsPolicyCompliances(InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder builderForValue)

public InstanceOSPoliciesCompliance.Builder addOsPolicyCompliances(InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder builderForValue)

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
NameDescription
builderForValueInstanceOSPoliciesCompliance.OSPolicyCompliance.Builder
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

addOsPolicyCompliances(int index, InstanceOSPoliciesCompliance.OSPolicyCompliance value)

public InstanceOSPoliciesCompliance.Builder addOsPolicyCompliances(int index, InstanceOSPoliciesCompliance.OSPolicyCompliance value)

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];

Parameters
NameDescription
indexint
valueInstanceOSPoliciesCompliance.OSPolicyCompliance
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

addOsPolicyCompliances(int index, InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder builderForValue)

public InstanceOSPoliciesCompliance.Builder addOsPolicyCompliances(int index, InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder builderForValue)

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];

Parameters
NameDescription
indexint
builderForValueInstanceOSPoliciesCompliance.OSPolicyCompliance.Builder
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

addOsPolicyCompliancesBuilder()

public InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder addOsPolicyCompliancesBuilder()

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
TypeDescription
InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder

addOsPolicyCompliancesBuilder(int index)

public InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder addOsPolicyCompliancesBuilder(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
NameDescription
indexint
Returns
TypeDescription
InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceOSPoliciesCompliance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder
Overrides

build()

public InstanceOSPoliciesCompliance build()
Returns
TypeDescription
InstanceOSPoliciesCompliance

buildPartial()

public InstanceOSPoliciesCompliance buildPartial()
Returns
TypeDescription
InstanceOSPoliciesCompliance

clear()

public InstanceOSPoliciesCompliance.Builder clear()
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder
Overrides

clearDetailedState()

public InstanceOSPoliciesCompliance.Builder clearDetailedState()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clearDetailedStateReason()

public InstanceOSPoliciesCompliance.Builder clearDetailedStateReason()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InstanceOSPoliciesCompliance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder
Overrides

clearInstance()

public InstanceOSPoliciesCompliance.Builder clearInstance()

Output only. The Compute Engine VM instance name.

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

Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clearLastComplianceCheckTime()

public InstanceOSPoliciesCompliance.Builder clearLastComplianceCheckTime()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

clearLastComplianceRunId()

public InstanceOSPoliciesCompliance.Builder clearLastComplianceRunId()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clearName()

public InstanceOSPoliciesCompliance.Builder clearName()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceOSPoliciesCompliance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder
Overrides

clearOsPolicyCompliances()

public InstanceOSPoliciesCompliance.Builder clearOsPolicyCompliances()

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
TypeDescription
InstanceOSPoliciesCompliance.Builder

clearState()

public InstanceOSPoliciesCompliance.Builder clearState()

Output only. Compliance state of the VM.

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

Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder

This builder for chaining.

clone()

public InstanceOSPoliciesCompliance.Builder clone()
Returns
TypeDescription
InstanceOSPoliciesCompliance.Builder
Overrides

getDefaultInstanceForType()

public InstanceOSPoliciesCompliance getDefaultInstanceForType()
Returns
TypeDescription
InstanceOSPoliciesCompliance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The lastComplianceCheckTime.

getLastComplianceCheckTimeBuilder()

public Timestamp.Builder getLastComplianceCheckTimeBuilder()

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
TypeDescription
Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
InstanceOSPoliciesCompliance.OSPolicyCompliance

getOsPolicyCompliancesBuilder(int index)

public InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder getOsPolicyCompliancesBuilder(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
NameDescription
indexint
Returns
TypeDescription
InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder

getOsPolicyCompliancesBuilderList()

public List<InstanceOSPoliciesCompliance.OSPolicyCompliance.Builder> getOsPolicyCompliancesBuilderList()

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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
List<OSPolicyCompliance>

getOsPolicyCompliancesOrBuilder(int index)

public InstanceOSPoliciesCompliance.OSPolicyComplianceOrBuilder getOsPolicyCompliancesOrBuilder(int index)