Google Cloud Security Center Management V1 Client - Class EventThreatDetectionCustomModule (0.3.2)

Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class EventThreatDetectionCustomModule.

An event threat detection custom module is a Cloud SCC resource that contains the configuration and enablement state of a custom module, which enables ETD to write certain findings to Cloud SCC.

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 ETD custom module. Its format is: * organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}. * folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}. * projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
↳ config Google\Protobuf\Struct

Optional. 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. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule 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. e.g. CONFIGURABLE_BAD_IP.
↳ display_name string

Optional. The human readable name to be displayed for the module.
↳ description string

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

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
Returns
Type Description
string

setName

Identifier. The resource name of the ETD custom module.

Its format is:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}.
Parameter
Name Description
var string
Returns
Type Description
$this

getConfig

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

Optional. 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. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. 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. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the EventThreatDetectionCustomModule 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

setEnablementState

Optional. The state of enablement for the module at the given level of the hierarchy.

Parameter
Name Description
var int
Returns
Type Description
$this

getType

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

Returns
Type Description
string

setType

Optional. Type for the module. e.g. CONFIGURABLE_BAD_IP.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. The human readable name to be displayed for the module.

Returns
Type Description
string

setDisplayName

Optional. The human readable name to be displayed for the module.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The description for the module.

Returns
Type Description
string

setDescription

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