Class: Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule

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

Overview

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 an ancestor organization or folder, then the enablement state is set to the value that is effective in the parent, not to INHERITED. For example, if the module is enabled in an organization or folder, then the effective enablement state for the module is ENABLED in all descendant folders or projects.

Defined Under Namespace

Modules: EnablementState

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 150

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

  # The enablement state of the module.
  module EnablementState
    # Default value. This value is unused.
    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 150

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

  # The enablement state of the module.
  module EnablementState
    # Default value. This value is unused.
    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::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState (readonly)

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

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 150

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

  # The enablement state of the module.
  module EnablementState
    # Default value. This value is unused.
    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

Returns Identifier. The full resource name of the custom module, in one of the following formats:

  • organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}
  • folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}
  • projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}.

Returns:

  • (::String) —

    Identifier. The full resource name of the custom module, in one of the following formats:

    • organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}
    • folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}
    • projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb', line 150

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

  # The enablement state of the module.
  module EnablementState
    # Default value. This value is unused.
    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