Google Cloud Security Command Center V1 Client - Class EffectiveEventThreatDetectionCustomModule (1.31.0)

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

An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablement_state property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of INHERITED.

For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveEventThreatDetectionCustomModule is read-only.

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

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the effective ETD custom module. Its format is: * organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}. * projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{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

Output only. The resource name of the effective ETD custom module.

Its format is:

  • organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
Returns
Type Description
string

setName

Output only. The resource name of the effective ETD custom module.

Its format is:

  • organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}.
  • projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{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