You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.</p>
<pre>Gets an effective Event Threat Detection custom module at the given level.
98
+
99
+
Args:
100
+
name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
101
+
x__xgafv: string, V1 error format.
102
+
Allowed values
103
+
1 - v1 error format
104
+
2 - v2 error format
105
+
106
+
Returns:
107
+
An object of the form:
108
+
109
+
{ # 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.
110
+
"config": { # Output only. Config for the effective module.
111
+
"a_key": "", # Properties of the object.
112
+
},
113
+
"description": "A String", # Output only. The description for the module.
114
+
"displayName": "A String", # Output only. The human readable name to be displayed for the module.
115
+
"enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
116
+
"name": "A 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}".
117
+
"type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
<pre>Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
124
+
125
+
Args:
126
+
parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
127
+
pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
128
+
pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
129
+
x__xgafv: string, V1 error format.
130
+
Allowed values
131
+
1 - v1 error format
132
+
2 - v2 error format
133
+
134
+
Returns:
135
+
An object of the form:
136
+
137
+
{ # Response for listing EffectiveEventThreatDetectionCustomModules.
138
+
"effectiveEventThreatDetectionCustomModules": [ # Effective custom modules belonging to the requested parent.
139
+
{ # 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.
140
+
"config": { # Output only. Config for the effective module.
141
+
"a_key": "", # Properties of the object.
142
+
},
143
+
"description": "A String", # Output only. The description for the module.
144
+
"displayName": "A String", # Output only. The human readable name to be displayed for the module.
145
+
"enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
146
+
"name": "A 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}".
147
+
"type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
148
+
},
149
+
],
150
+
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
<pre>Validates the given Event Threat Detection Custom Module.
101
+
<pre>Validates the given Event Threat Detection custom module.
97
102
98
103
Args:
99
104
parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
100
105
body: object, The request body.
101
106
The object takes the form of:
102
107
103
-
{ # Request to validate an EventThreatDetectionCustomModule.
108
+
{ # Request to validate an Event Threat Detection custom module.
104
109
"rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
105
110
"type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
106
111
}
@@ -113,7 +118,7 @@ <h3>Method Details</h3>
113
118
Returns:
114
119
An object of the form:
115
120
116
-
{ # Response to validating an Event Threat Detection Custom Module.
121
+
{ # Response to validating an Event Threat Detection custom module.
117
122
"errors": { # A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. # A list of errors returned by the validator. If the list is empty, there were no errors.
118
123
"errors": [
119
124
{ # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
Copy file name to clipboardExpand all lines: docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html
+1-1
Original file line number
Diff line number
Diff line change
@@ -470,7 +470,7 @@ <h3>Method Details</h3>
470
470
"updateTime": "A String", # Output only. The time at which the custom module was last updated.
471
471
}
472
472
473
-
updateMask: string, The list of fields to update.
473
+
updateMask: string, The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
0 commit comments