# Google Cloud Security Center Management V1 Client - Class SecurityHealthAnalyticsCustomModule (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 SecurityHealthAnalyticsCustomModule.

Represents an instance of a Security Health Analytics custom module,
including its full module name, display name, enablement state, and last
updated time. You can create a custom module at the organization, folder, or
project level. Custom modules that you create at the organization or folder
level are inherited by the descendant folders and projects.

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

## 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}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` \* \* `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` \* \* `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}` |
| `↳ display_name` | `string` Optional. The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. |
| `↳ enablement_state` | `int` Optional. The enablement state of the custom module. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. The time at which the custom module was last updated. |
| `↳ last_editor` | `string` Output only. The editor that last updated the custom module. |
| `↳ ancestor_module` | `string` Output only. Specifies the organization or folder from which the custom module is inherited. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. |
| `↳ custom_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-securitycentermanagement/latest/V1.CustomConfig` Optional. The user-specified custom configuration for the module. |

### getName

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

- `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
- `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
- `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

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

- `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
- `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
- `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`

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

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

### getDisplayName

Optional. The display name of the Security Health Analytics custom module.

This display name becomes the finding category for all findings that are
returned by this custom module. The display 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

Optional. The display name of the Security Health Analytics custom module.

This display name becomes the finding category for all findings that are
returned by this custom module. The display 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` |   |

### getEnablementState

Optional. The enablement state of the custom module.

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

### setEnablementState

Optional. The enablement state of the custom module.

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

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

### getUpdateTime

Output only. The time at which the custom module was last updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

Output only. The time at which the custom module was last updated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

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

### getLastEditor

Output only. The editor that last updated the custom module.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setLastEditor

Output only. The editor that last updated the custom module.

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

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

### getAncestorModule

Output only. Specifies the organization or folder from which the custom
module is inherited. If empty, indicates that the custom module was created
in the organization, folder, or project in which you are viewing the custom
module.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setAncestorModule

Output only. Specifies the organization or folder from which the custom
module is inherited. If empty, indicates that the custom module was created
in the organization, folder, or project in which you are viewing the custom
module.

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

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

### getCustomConfig

Optional. The user-specified custom configuration for the module.

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

### hasCustomConfig

### clearCustomConfig

### setCustomConfig

Optional. The user-specified custom 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` |   |