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

Inherits:

Object

• Object
• Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport::OSPolicyCompliance::OSPolicyResourceCompliance

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

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

  The compliance state of the resource.

• #compliance_state_reason ⇒ ::String

  A reason for the resource to be in the given compliance state.

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

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

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

  ExecResource specific output.

• #os_policy_resource_id ⇒ ::String

  The ID of the OS policy resource.

Instance Attribute Details

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

# 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

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

# 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

# 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

# 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