REST Resource: folders.eventThreatDetectionSettings.customModules

Resource: EventThreatDetectionCustomModule

Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.

JSON representation 
{
  "name": string,
  "config": {
    object
  },
  "ancestorModule": string,
  "enablementState": enum (EnablementState),
  "type": string,
  "displayName": string,
  "description": string,
  "updateTime": string,
  "lastEditor": string
}
Fields
name

string

Immutable. The resource name of the Event Threat Detection custom module.

Its format is:

  • organizations/{organization}/eventThreatDetectionSettings/customModules/{module}.
  • folders/{folder}/eventThreatDetectionSettings/customModules/{module}.
  • projects/{project}/eventThreatDetectionSettings/customModules/{module}.
config

object (Struct format)

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

string

Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
enablementState

enum (EnablementState)

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

string

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

string

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

string

The description for the module.
updateTime

string (Timestamp format)

Output only. The time the module was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastEditor

string

Output only. The editor the module was last updated by.

EnablementState

The enablement state of the module.

Enums
ENABLEMENT_STATE_UNSPECIFIED Unspecified enablement state.
ENABLED The module is enabled at the given level.
DISABLED The module is disabled at the given level.
INHERITED When the enablement state is inherited.

Methods

create

 Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent.

delete

 Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy.

get

 Gets an Event Threat Detection custom module.

list

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

listDescendant

 Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

patch

 Updates the Event Threat Detection custom module with the given name based on the given update mask.