Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class EventThreatDetectionCustomModule.
Represents an instance of an Event Threat Detection 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 child folders and projects.
Generated from protobuf message google.cloud.securitycenter.v1.EventThreatDetectionCustomModule
Namespace
Google \ Cloud \ SecurityCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The resource name of the Event Threat Detection custom module. Its format is: * |
↳ config |
Google\Protobuf\Struct
Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. |
↳ ancestor_module |
string
Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. |
↳ enablement_state |
int
The state of enablement for the module at the given level of the hierarchy. |
↳ type |
string
Type for the module. e.g. CONFIGURABLE_BAD_IP. |
↳ display_name |
string
The human readable name to be displayed for the module. |
↳ description |
string
The description for the module. |
↳ update_time |
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
Immutable. The resource name of the Event Threat Detection custom module.
Its format is:
organizations/{organization}/eventThreatDetectionSettings/customModules/{module}.folders/{folder}/eventThreatDetectionSettings/customModules/{module}.projects/{project}/eventThreatDetectionSettings/customModules/{module}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. The resource name of the Event Threat Detection custom module.
Its format is:
organizations/{organization}/eventThreatDetectionSettings/customModules/{module}.folders/{folder}/eventThreatDetectionSettings/customModules/{module}.projects/{project}/eventThreatDetectionSettings/customModules/{module}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfig
Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasConfig
clearConfig
setConfig
Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAncestorModule
Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAncestorModule
Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnablementState
The state of enablement for the module at the given level of the hierarchy.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEnablementState
The state of enablement for the module at the given level of the hierarchy.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Type for the module. e.g. CONFIGURABLE_BAD_IP.
| Returns | |
|---|---|
| Type | Description |
string |
|
setType
Type for the module. e.g. CONFIGURABLE_BAD_IP.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The human readable name to be displayed for the module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The human readable name to be displayed for the module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
The description for the module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
The description for the module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time the module was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the module was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
|