# Google Cloud Security Center Management V1 Client - Class EffectiveSecurityHealthAnalyticsCustomModule (1.4.0)

1.4.0 (latest) 1.3.3 1.2.1 1.1.3 1.0.0 0.3.2 0.2.7 0.1.0 Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class 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.

Generated from protobuf message `google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule`

## Namespace

Google \\ Cloud \\ SecurityCenterManagement \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `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}` |
| `↳ custom_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.CustomConfig` Output only. The user-specified configuration for the module. |
| `↳ enablement_state` | `int` Output only. The effective enablement state for the module at the given level of the hierarchy. |
| `↳ display_name` | `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. |

### getName

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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCustomConfig

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.CustomConfig|null` |   |

### hasCustomConfig

### clearCustomConfig

### setCustomConfig

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.CustomConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEnablementState

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [EnablementState](https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState). |

### setEnablementState

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [EnablementState](https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.EffectiveSecurityHealthAnalyticsCustomModule.EnablementState). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDisplayName

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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |