Class: Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance Deprecated

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb

Overview

Deprecated.

This message is deprecated and may be removed in the next major version update.

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.

Defined Under Namespace

Classes: OSPolicyCompliance

Instance Attribute Summary collapse

Instance Attribute Details

#detailed_state ⇒ ::String (readonly)

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

Returns:

  • (::String) —

    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.


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#detailed_state_reason ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#instance ⇒ ::String (readonly)

Returns Output only. The Compute Engine VM instance name.

Returns:

  • (::String) —

    Output only. The Compute Engine VM instance name.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#last_compliance_check_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#last_compliance_run_id ⇒ ::String (readonly)

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

Returns:

  • (::String) —

    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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The InstanceOSPoliciesCompliance API resource name.

Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}.

Returns:

  • (::String) —

    Output only. The InstanceOSPoliciesCompliance API resource name.

    Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#os_policy_compliances ⇒ ::Array<::Google::Cloud::OsConfig::V1alpha::InstanceOSPoliciesCompliance::OSPolicyCompliance> (readonly)

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

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState (readonly)

Returns Output only. Compliance state of the VM.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/cloud/osconfig/v1alpha/instance_os_policies_compliance.rb', line 79

class InstanceOSPoliciesCompliance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Compliance data for an OS policy
  # @deprecated This message is deprecated and may be removed in the next major version update.
  # @!attribute [rw] os_policy_id
  #   @return [::String]
  #     The OS policy id
  # @!attribute [rw] os_policy_assignment
  #   @return [::String]
  #     Reference to the `OSPolicyAssignment` API resource that the `OSPolicy`
  #     belongs to.
  #
  #     Format:
  #     `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
  # @!attribute [rw] state
  #   @return [::Google::Cloud::OsConfig::V1alpha::OSPolicyComplianceState]
  #     Compliance state of the OS policy.
  # @!attribute [rw] os_policy_resource_compliances
  #   @return [::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicyResourceCompliance>]
  #     Compliance data for each `OSPolicyResource` that is applied to the
  #     VM.
  class OSPolicyCompliance
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end