Google Cloud Security Center Management V1 Client - Class EffectiveEventThreatDetectionCustomModule (1.0.0)

Version latest

• 1.0.0 (latest)
• 0.3.2
• 0.2.7
• 0.1.0

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

An EffectiveEventThreatDetectionCustomModule is the representation of EventThreatDetectionCustomModule at a given level taking hierarchy into account and resolving various fields accordingly. e.g. if the module is enabled at the ancestor level, effective modules at all descendant levels will have enablement_state set to ENABLED. Similarly, if module.inherited is set, then effective module's config will contain the ancestor's config details. EffectiveEventThreatDetectionCustomModule is read-only.

Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule

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}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}. * folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}. * projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
↳ config	Google\Protobuf\Struct Output only. Config for the effective module.
↳ enablement_state	int Output only. The effective state of enablement for the module at the given level of the hierarchy.
↳ type	string Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
↳ display_name	string Output only. The human readable name to be displayed for the module.
↳ description	string Output only. The description for the module.

getName

Identifier. The resource name of the ETD custom module.

Its format is:

• organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
• folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
• projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_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}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
• folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.
• projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConfig

Output only. Config for the effective module.

Returns
Type	Description
Google\Protobuf\Struct|null

hasConfig

clearConfig

setConfig

Output only. Config for the effective module.

Parameter
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this

getEnablementState

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

Returns
Type	Description
int

setEnablementState

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getType

Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

Returns
Type	Description
string

setType

Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Output only. The human readable name to be displayed for the module.

Returns
Type	Description
string

setDisplayName

Output only. The human readable name to be displayed for the module.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Output only. The description for the module.

Returns
Type	Description
string

setDescription

Output only. The description for the module.

Parameter
Name	Description
var	string

Returns
Type	Description
$this