# Security Command Center Management V1 API - Class Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule (v1.8.0)

1.8.0 (latest) 1.7.1 1.6.0 1.5.1 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Security Command Center Management V1 API class Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule.

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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #custom_config

    def custom_config() -> ::Google::Cloud::SecurityCenterManagement::V1::CustomConfig

**Returns**

- ([::Google::Cloud::SecurityCenterManagement::V1::CustomConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-security_center_management-v1/latest/Google-Cloud-SecurityCenterManagement-V1-CustomConfig)) --- Output only. The user-specified configuration for the module.

### #display_name

    def display_name() -> ::String

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

### #enablement_state

    def enablement_state() -> ::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState

**Returns**

- ([::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-security_center_management-v1/latest/Google-Cloud-SecurityCenterManagement-V1-EffectiveSecurityHealthAnalyticsCustomModule-EnablementState)) --- Output only. The effective enablement state for the module at the given level of the hierarchy.

### #name

    def name() -> ::String

**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}`

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::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}`
**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}`