Class: Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance

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

Overview

Compliance data for an OS policy resource.

Defined Under Namespace

Modules: ComplianceState Classes: ExecResourceOutput, OSPolicyResourceConfigStep

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_state ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::ComplianceState

Returns The compliance state of the resource.

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy_assignment_reports.rb', line 199

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

  # Step performed by the OS Config agent for configuring an
  # `OSPolicy` resource to its desired state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
  #     Configuration step type.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     An error message recorded during the execution of this step.
  #     Only populated if errors were encountered during this step execution.
  class OSPolicyResourceConfigStep
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported configuration step types
    module Type
      # Default value. This value is unused.
      TYPE_UNSPECIFIED = 0

      # Checks for resource conflicts such as schema errors.
      VALIDATION = 1

      # Checks the current status of the desired state for a resource.
      DESIRED_STATE_CHECK = 2

      # Enforces the desired state for a resource that is not in desired
      # state.
      DESIRED_STATE_ENFORCEMENT = 3

      # Re-checks the status of the desired state. This check is done
      # for a resource after the enforcement of all OS policies.
      #
      # This step is used to determine the final desired state status for
      # the resource. It accounts for any resources that might have drifted
      # from their desired state due to side effects from executing other
      # resources.
      DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
    end
  end

  # ExecResource specific output.
  # @!attribute [rw] enforcement_output
  #   @return [::String]
  #     Output from enforcement phase output file (if run).
  #     Output size is limited to 100K bytes.
  class ExecResourceOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible compliance states for a resource.
  module ComplianceState
    # The resource is in an unknown compliance state.
    #
    # To get more details about why the policy is in this state, review
    # the output of the `compliance_state_reason` field.
    UNKNOWN = 0

    # Resource is compliant.
    COMPLIANT = 1

    # Resource is non-compliant.
    NON_COMPLIANT = 2
  end
end

#compliance_state_reason ⇒ ::String

Returns A reason for the resource to be in the given compliance state. This field is always populated when compliance_state is UNKNOWN.

The following values are supported when compliance_state == UNKNOWN

  • execution-errors: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined.
  • execution-skipped-by-agent: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy.
  • os-policy-execution-attempt-failed: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined.

Returns:

  • (::String) —

    A reason for the resource to be in the given compliance state. This field is always populated when compliance_state is UNKNOWN.

    The following values are supported when compliance_state == UNKNOWN

    • execution-errors: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined.
    • execution-skipped-by-agent: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy.
    • os-policy-execution-attempt-failed: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined.


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy_assignment_reports.rb', line 199

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

  # Step performed by the OS Config agent for configuring an
  # `OSPolicy` resource to its desired state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
  #     Configuration step type.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     An error message recorded during the execution of this step.
  #     Only populated if errors were encountered during this step execution.
  class OSPolicyResourceConfigStep
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported configuration step types
    module Type
      # Default value. This value is unused.
      TYPE_UNSPECIFIED = 0

      # Checks for resource conflicts such as schema errors.
      VALIDATION = 1

      # Checks the current status of the desired state for a resource.
      DESIRED_STATE_CHECK = 2

      # Enforces the desired state for a resource that is not in desired
      # state.
      DESIRED_STATE_ENFORCEMENT = 3

      # Re-checks the status of the desired state. This check is done
      # for a resource after the enforcement of all OS policies.
      #
      # This step is used to determine the final desired state status for
      # the resource. It accounts for any resources that might have drifted
      # from their desired state due to side effects from executing other
      # resources.
      DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
    end
  end

  # ExecResource specific output.
  # @!attribute [rw] enforcement_output
  #   @return [::String]
  #     Output from enforcement phase output file (if run).
  #     Output size is limited to 100K bytes.
  class ExecResourceOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible compliance states for a resource.
  module ComplianceState
    # The resource is in an unknown compliance state.
    #
    # To get more details about why the policy is in this state, review
    # the output of the `compliance_state_reason` field.
    UNKNOWN = 0

    # Resource is compliant.
    COMPLIANT = 1

    # Resource is non-compliant.
    NON_COMPLIANT = 2
  end
end

#config_steps ⇒ ::Array<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep>

Returns Ordered list of configuration completed by the agent for the OS policy resource.

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy_assignment_reports.rb', line 199

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

  # Step performed by the OS Config agent for configuring an
  # `OSPolicy` resource to its desired state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
  #     Configuration step type.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     An error message recorded during the execution of this step.
  #     Only populated if errors were encountered during this step execution.
  class OSPolicyResourceConfigStep
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported configuration step types
    module Type
      # Default value. This value is unused.
      TYPE_UNSPECIFIED = 0

      # Checks for resource conflicts such as schema errors.
      VALIDATION = 1

      # Checks the current status of the desired state for a resource.
      DESIRED_STATE_CHECK = 2

      # Enforces the desired state for a resource that is not in desired
      # state.
      DESIRED_STATE_ENFORCEMENT = 3

      # Re-checks the status of the desired state. This check is done
      # for a resource after the enforcement of all OS policies.
      #
      # This step is used to determine the final desired state status for
      # the resource. It accounts for any resources that might have drifted
      # from their desired state due to side effects from executing other
      # resources.
      DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
    end
  end

  # ExecResource specific output.
  # @!attribute [rw] enforcement_output
  #   @return [::String]
  #     Output from enforcement phase output file (if run).
  #     Output size is limited to 100K bytes.
  class ExecResourceOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible compliance states for a resource.
  module ComplianceState
    # The resource is in an unknown compliance state.
    #
    # To get more details about why the policy is in this state, review
    # the output of the `compliance_state_reason` field.
    UNKNOWN = 0

    # Resource is compliant.
    COMPLIANT = 1

    # Resource is non-compliant.
    NON_COMPLIANT = 2
  end
end

#exec_resource_output ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::ExecResourceOutput

Returns ExecResource specific output.

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy_assignment_reports.rb', line 199

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

  # Step performed by the OS Config agent for configuring an
  # `OSPolicy` resource to its desired state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
  #     Configuration step type.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     An error message recorded during the execution of this step.
  #     Only populated if errors were encountered during this step execution.
  class OSPolicyResourceConfigStep
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported configuration step types
    module Type
      # Default value. This value is unused.
      TYPE_UNSPECIFIED = 0

      # Checks for resource conflicts such as schema errors.
      VALIDATION = 1

      # Checks the current status of the desired state for a resource.
      DESIRED_STATE_CHECK = 2

      # Enforces the desired state for a resource that is not in desired
      # state.
      DESIRED_STATE_ENFORCEMENT = 3

      # Re-checks the status of the desired state. This check is done
      # for a resource after the enforcement of all OS policies.
      #
      # This step is used to determine the final desired state status for
      # the resource. It accounts for any resources that might have drifted
      # from their desired state due to side effects from executing other
      # resources.
      DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
    end
  end

  # ExecResource specific output.
  # @!attribute [rw] enforcement_output
  #   @return [::String]
  #     Output from enforcement phase output file (if run).
  #     Output size is limited to 100K bytes.
  class ExecResourceOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible compliance states for a resource.
  module ComplianceState
    # The resource is in an unknown compliance state.
    #
    # To get more details about why the policy is in this state, review
    # the output of the `compliance_state_reason` field.
    UNKNOWN = 0

    # Resource is compliant.
    COMPLIANT = 1

    # Resource is non-compliant.
    NON_COMPLIANT = 2
  end
end

#os_policy_resource_id ⇒ ::String

Returns The ID of the OS policy resource.

Returns:

  • (::String) —

    The ID of the OS policy resource.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'proto_docs/google/cloud/osconfig/v1/os_policy_assignment_reports.rb', line 199

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

  # Step performed by the OS Config agent for configuring an
  # `OSPolicy` resource to its desired state.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance::OSPolicyResourceConfigStep::Type]
  #     Configuration step type.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     An error message recorded during the execution of this step.
  #     Only populated if errors were encountered during this step execution.
  class OSPolicyResourceConfigStep
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Supported configuration step types
    module Type
      # Default value. This value is unused.
      TYPE_UNSPECIFIED = 0

      # Checks for resource conflicts such as schema errors.
      VALIDATION = 1

      # Checks the current status of the desired state for a resource.
      DESIRED_STATE_CHECK = 2

      # Enforces the desired state for a resource that is not in desired
      # state.
      DESIRED_STATE_ENFORCEMENT = 3

      # Re-checks the status of the desired state. This check is done
      # for a resource after the enforcement of all OS policies.
      #
      # This step is used to determine the final desired state status for
      # the resource. It accounts for any resources that might have drifted
      # from their desired state due to side effects from executing other
      # resources.
      DESIRED_STATE_CHECK_POST_ENFORCEMENT = 4
    end
  end

  # ExecResource specific output.
  # @!attribute [rw] enforcement_output
  #   @return [::String]
  #     Output from enforcement phase output file (if run).
  #     Output size is limited to 100K bytes.
  class ExecResourceOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible compliance states for a resource.
  module ComplianceState
    # The resource is in an unknown compliance state.
    #
    # To get more details about why the policy is in this state, review
    # the output of the `compliance_state_reason` field.
    UNKNOWN = 0

    # Resource is compliant.
    COMPLIANT = 1

    # Resource is non-compliant.
    NON_COMPLIANT = 2
  end
end