custom_modules_descendant

Creates, updates, deletes, gets or lists a custom_modules_descendant resource.

Overview

Name	custom_modules_descendant
Type	Resource
Id	google.securitycenter.custom_modules_descendant

Fields

The following fields are returned by SELECT queries:

folders_security_health_analytics_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

folders_event_threat_detection_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
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}.
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.
cloudProvider	string	The cloud provider of the custom module.
config	object	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.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

projects_security_health_analytics_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

projects_event_threat_detection_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
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}.
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.
cloudProvider	string	The cloud provider of the custom module.
config	object	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.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

organizations_security_health_analytics_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModule	string	Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
cloudProvider	string	The cloud provider of the custom module.
customConfig	object	The user specified custom configuration for the module. (id: GoogleCloudSecuritycenterV1CustomConfig)
displayName	string	The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementState	string	The enablement state of the custom module.
lastEditor	string	Output only. The editor that last updated the custom module.
updateTime	string (google-datetime)	Output only. The time at which the custom module was last updated.

organizations_event_threat_detection_settings_custom_modules_list_descendant

Successful response

Name	Datatype	Description
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}.
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.
cloudProvider	string	The cloud provider of the custom module.
config	object	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.
description	string	The description for the module.
displayName	string	The human readable name to be displayed for the module.
enablementState	string	The state of enablement for the module at the given level of the hierarchy.
lastEditor	string	Output only. The editor the module was last updated by.
type	string	Type for the module. e.g. CONFIGURABLE_BAD_IP.
updateTime	string (google-datetime)	Output only. The time the module was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_security_health_analytics_settings_custom_modules_list_descendant	select	foldersId	pageSize, pageToken	Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
folders_event_threat_detection_settings_custom_modules_list_descendant	select	foldersId	pageToken, pageSize	Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
projects_security_health_analytics_settings_custom_modules_list_descendant	select	projectsId	pageSize, pageToken	Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
projects_event_threat_detection_settings_custom_modules_list_descendant	select	projectsId	pageToken, pageSize	Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
organizations_security_health_analytics_settings_custom_modules_list_descendant	select	organizationsId	pageSize, pageToken	Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
organizations_event_threat_detection_settings_custom_modules_list_descendant	select	organizationsId	pageToken, pageSize	Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
foldersId	string
organizationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

folders_security_health_analytics_settings_custom_modules_list_descendant

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE foldersId = '{{ foldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

folders_event_threat_detection_settings_custom_modules_list_descendant

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

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

projects_security_health_analytics_settings_custom_modules_list_descendant

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_event_threat_detection_settings_custom_modules_list_descendant

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

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_security_health_analytics_settings_custom_modules_list_descendant

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

SELECT
name,
ancestorModule,
cloudProvider,
customConfig,
displayName,
enablementState,
lastEditor,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_event_threat_detection_settings_custom_modules_list_descendant

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

SELECT
name,
ancestorModule,
cloudProvider,
config,
description,
displayName,
enablementState,
lastEditor,
type,
updateTime
FROM google.securitycenter.custom_modules_descendant
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';