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

Version latest

• 1.1.1 (latest)
• 1.1.0
• 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 EffectiveEventThreatDetectionCustomModule.

The representation of an EventThreatDetectionCustomModule at a given level, taking hierarchy into account and resolving various fields accordingly. For example, if the module is enabled at the ancestor level, then effective modules at all descendant levels will have their enablement state set to ENABLED. Similarly, if module.inherited is set, then the effective module's configuration will reflect the ancestor's configuration.

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 Event Threat Detection custom module, in one of the following formats: * * organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module} * * folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module} * * projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}
↳ config	Google\Protobuf\Struct Output only. Configuration 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 (for example, CONFIGURABLE_BAD_IP).
↳ display_name	string Output only. The human-readable name of the module.
↳ description	string Output only. A description of the module.

getName

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

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConfig

Output only. Configuration for the effective module.

Returns
Type	Description
Google\Protobuf\Struct|null

hasConfig

clearConfig

setConfig

Output only. Configuration 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 (for example, CONFIGURABLE_BAD_IP).

Returns
Type	Description
string

setType

Output only. Type for the module (for example, CONFIGURABLE_BAD_IP).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Output only. The human-readable name of the module.

Returns
Type	Description
string

setDisplayName

Output only. The human-readable name of the module.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Output only. A description of the module.

Returns
Type	Description
string

setDescription

Output only. A description of the module.

Parameter
Name	Description
var	string

Returns
Type	Description
$this