Class OSPolicyAssignmentReport.OSPolicyCompliance.Builder (2.4.3)

public static final class OSPolicyAssignmentReport.OSPolicyCompliance.Builder extends GeneratedMessageV3.Builder<OSPolicyAssignmentReport.OSPolicyCompliance.Builder> implements OSPolicyAssignmentReport.OSPolicyComplianceOrBuilder

Compliance data for an OS policy

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

Static Methods

getDescriptor()

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

Methods

addAllOsPolicyResourceCompliances(Iterable<? extends OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance> values)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder addAllOsPolicyResourceCompliances(Iterable<? extends OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance> values)

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
valuesIterable<? extends com.google.cloud.osconfig.v1.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance>
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

addOsPolicyResourceCompliances(OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance value)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder addOsPolicyResourceCompliances(OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance value)

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
valueOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

addOsPolicyResourceCompliances(OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder builderForValue)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder addOsPolicyResourceCompliances(OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder builderForValue)

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
builderForValueOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

addOsPolicyResourceCompliances(int index, OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance value)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder addOsPolicyResourceCompliances(int index, OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance value)

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;

Parameters
NameDescription
indexint
valueOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

addOsPolicyResourceCompliances(int index, OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder builderForValue)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder addOsPolicyResourceCompliances(int index, OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueOSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

addOsPolicyResourceCompliancesBuilder()

public OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder addOsPolicyResourceCompliancesBuilder()

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
OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder

addOsPolicyResourceCompliancesBuilder(int index)

public OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder addOsPolicyResourceCompliancesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clear()
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder
Overrides

clearComplianceState()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clearComplianceState()

The compliance state of the OS policy.

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

Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

This builder for chaining.

clearComplianceStateReason()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clearComplianceStateReason()

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
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOsPolicyId()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clearOsPolicyId()

The OS policy id

string os_policy_id = 1;

Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

This builder for chaining.

clearOsPolicyResourceCompliances()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clearOsPolicyResourceCompliances()

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
OSPolicyAssignmentReport.OSPolicyCompliance.Builder

clone()

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder clone()
Returns
TypeDescription
OSPolicyAssignmentReport.OSPolicyCompliance.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getOsPolicyResourceCompliancesBuilder(int index)

public OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder getOsPolicyResourceCompliancesBuilder(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.Builder

getOsPolicyResourceCompliancesBuilderList()

public List<OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.Builder> getOsPolicyResourceCompliancesBuilderList()

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

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(OSPolicyAssignmentReport.OSPolicyCompliance other)

public OSPolicyAssignmentReport.OSPolicyCompliance.Builder mergeFrom(OSPolicyAssignmentReport.OSPolicyCompliance other)
Parameter
NameDescription
otherOSPolicyAssignmentReport.OSPolicyCompliance
Returns <