Class: Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule

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

Overview

An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablementState property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only.

Defined Under Namespace

Modules: EnablementState

Instance Attribute Summary collapse

Instance Attribute Details

#custom_config ⇒ ::Google::Cloud::SecurityCenter::V1::CustomConfig (readonly)

Returns Output only. The user-specified configuration for the module.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'proto_docs/google/cloud/securitycenter/v1/effective_security_health_analytics_custom_module.rb', line 54

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given level.
    ENABLED = 1

    # The module is disabled at the given level.
    DISABLED = 2
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

Returns:

  • (::String) —

    Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'proto_docs/google/cloud/securitycenter/v1/effective_security_health_analytics_custom_module.rb', line 54

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given level.
    ENABLED = 1

    # The module is disabled at the given level.
    DISABLED = 2
  end
end

#enablement_state ⇒ ::Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState (readonly)

Returns Output only. The effective state of enablement for the module at the given level of the hierarchy.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'proto_docs/google/cloud/securitycenter/v1/effective_security_health_analytics_custom_module.rb', line 54

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given level.
    ENABLED = 1

    # The module is disabled at the given level.
    DISABLED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}".

Returns:

  • (::String) —

    Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'proto_docs/google/cloud/securitycenter/v1/effective_security_health_analytics_custom_module.rb', line 54

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

  # The enablement state of the module.
  module EnablementState
    # Unspecified enablement state.
    ENABLEMENT_STATE_UNSPECIFIED = 0

    # The module is enabled at the given level.
    ENABLED = 1

    # The module is disabled at the given level.
    DISABLED = 2
  end
end