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

A Security Command Center resource that contains the configuration and
enablement state of a custom module, which enables Event Threat Detection to
write certain findings to Security Command Center.

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

## Namespace

Google \\ Cloud \\ SecurityCenterManagement \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Identifier. The resource name of the Event Threat Detection custom module, in one of the following formats: \* \* `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` \* \* `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` \* \* `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}` |
| `↳ config` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` Optional. Configuration for the module. For the resident module, its configuration value is defined at this level. For the inherited module, its configuration value is inherited from the ancestor module. |
| `↳ ancestor_module` | `string` Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the custom module's resource name. |
| `↳ enablement_state` | `int` Optional. The state of enablement for the module at the given level of the hierarchy. |
| `↳ type` | `string` Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`. |
| `↳ display_name` | `string` Optional. The human-readable name of the module. |
| `↳ description` | `string` Optional. A description of the module. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. The time the module was last updated. |
| `↳ last_editor` | `string` Output only. The editor the module was last updated by. |

### getName

Identifier. The resource name of the Event Threat Detection custom module,
in one of the following formats:

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

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

### setName

Identifier. The resource name of the Event Threat Detection custom module,
in one of the following formats:

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

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

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

### getConfig

Optional. Configuration for the module. For the resident module, its
configuration value is defined at this level. For the inherited module, its
configuration value is inherited from the ancestor module.

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

### hasConfig

### clearConfig

### setConfig

Optional. Configuration for the module. For the resident module, its
configuration value is defined at this level. For the inherited module, its
configuration value is inherited from the ancestor module.

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

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

### getAncestorModule

Output only. The closest ancestor module that this module inherits the
enablement state from. If empty, indicates that the custom module was
created in the requesting parent organization, folder, or project. The
format is the same as the custom module's resource name.

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

### setAncestorModule

Output only. The closest ancestor module that this module inherits the
enablement state from. If empty, indicates that the custom module was
created in the requesting parent organization, folder, or project. The
format is the same as the custom module's resource name.

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

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

### getEnablementState

Optional. The state of enablement 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.EventThreatDetectionCustomModule.EnablementState). |

### setEnablementState

Optional. The state of enablement 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.EventThreatDetectionCustomModule.EnablementState). |

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

### getType

Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`.

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

### setType

Optional. Type for the module. For example, `CONFIGURABLE_BAD_IP`.

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

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

### getDisplayName

Optional. The human-readable name of the module.

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

### setDisplayName

Optional. The human-readable name of the module.

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

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

### getDescription

Optional. A description of the module.

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

### setDescription

Optional. A description of the module.

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

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

### getUpdateTime

Output only. The time the 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 the 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 the module was last updated by.

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

### setLastEditor

Output only. The editor the module was last updated by.

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

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