REST Resource: folders.locations.effectiveEventThreatDetectionCustomModules

Resource: 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.

JSON representation 
{
  "name": string,
  "config": {
    object
  },
  "enablementState": enum (EnablementState),
  "type": string,
  "displayName": string,
  "description": string
}
Fields
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

object (Struct format)

Output only. Configuration for the effective module.
enablementState

enum (EnablementState)

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).
displayName

string

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

string

Output only. A description of the module.

EnablementState

The enablement state of the module.

Enums
ENABLEMENT_STATE_UNSPECIFIED Default value. This value is unused.
ENABLED The module is enabled at the given level.
DISABLED The module is disabled at the given level.

Methods

get

 Gets the effective Event Threat Detection custom module at the given level.

list

 Lists all effective Event Threat Detection custom modules for the given parent.