Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class EffectiveSecurityHealthAnalyticsCustomModule.
An EffectiveSecurityHealthAnalyticsCustomModule is the representation of
a Security Health Analytics 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
enablementState property in EffectiveSecurityHealthAnalyticsCustomModule 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. EffectiveSecurityHealthAnalyticsCustomModule is read-only.
Generated from protobuf message google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule
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 custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
Output only. The user-specified configuration for the module.
↳ enablement_state
int
Output only. The effective state of enablement for the module at the given level of the hierarchy.
↳ display_name
string
Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
getName
Output only. The resource name of the custom module.
Its format is
"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
Returns
Type
Description
string
setName
Output only. The resource name of the custom module.
Its format is
"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCustomConfig
Output only. The user-specified configuration for the module.
Output only. The effective state of enablement for the module at the given
level of the hierarchy.
Returns
Type
Description
int
Enum of type EnablementState.
setEnablementState
Output only. The effective state of enablement for the module at the given
level of the hierarchy.
Parameter
Name
Description
var
int
Enum of type EnablementState.
Returns
Type
Description
$this
getDisplayName
Output only. The display name for the custom module. The name must be
between 1 and 128 characters, start with a lowercase letter, and contain
alphanumeric characters or underscores only.
Returns
Type
Description
string
setDisplayName
Output only. The display name for the custom module. The name must be
between 1 and 128 characters, start with a lowercase letter, and contain
alphanumeric characters or underscores only.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Security Command Center V1 Client - Class EffectiveSecurityHealthAnalyticsCustomModule (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-security-center/latest/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [2.2.0](/php/docs/reference/cloud-security-center/2.2.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [2.1.1](/php/docs/reference/cloud-security-center/2.1.1/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [2.0.4](/php/docs/reference/cloud-security-center/2.0.4/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.32.0](/php/docs/reference/cloud-security-center/1.32.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.31.0](/php/docs/reference/cloud-security-center/1.31.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.30.0](/php/docs/reference/cloud-security-center/1.30.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.29.0](/php/docs/reference/cloud-security-center/1.29.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.28.2](/php/docs/reference/cloud-security-center/1.28.2/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.21.0](/php/docs/reference/cloud-security-center/1.21.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.20.2](/php/docs/reference/cloud-security-center/1.20.2/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.19.1](/php/docs/reference/cloud-security-center/1.19.1/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.18.0](/php/docs/reference/cloud-security-center/1.18.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.17.0](/php/docs/reference/cloud-security-center/1.17.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.16.0](/php/docs/reference/cloud-security-center/1.16.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.15.1](/php/docs/reference/cloud-security-center/1.15.1/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.14.2](/php/docs/reference/cloud-security-center/1.14.2/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.13.1](/php/docs/reference/cloud-security-center/1.13.1/V1.EffectiveSecurityHealthAnalyticsCustomModule) \nReference documentation and code samples for the Google Cloud Security Command Center V1 Client class EffectiveSecurityHealthAnalyticsCustomModule.\n\nAn EffectiveSecurityHealthAnalyticsCustomModule is the representation of\na Security Health Analytics custom module at a specified level of the\nresource hierarchy: organization, folder, or project. If a custom module is\ninherited from a parent organization or folder, the value of the\n`enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is\nset to the value that is effective in the parent, instead of `INHERITED`.\n\nFor example, if the module is enabled in a parent organization or folder, the\neffective enablement_state for the module in all child folders or projects is\nalso `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only.\n\nGenerated from protobuf message `google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ SecurityCenter \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The resource name of the custom module.\n\nIts format is\n\"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\",\nor\n\"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\",\nor\n\"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"\n\n### setName\n\nOutput only. The resource name of the custom module.\n\nIts format is\n\"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\",\nor\n\"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\",\nor\n\"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"\n\n### getCustomConfig\n\nOutput only. The user-specified configuration for the module.\n\n### hasCustomConfig\n\n### clearCustomConfig\n\n### setCustomConfig\n\nOutput only. The user-specified configuration for the module.\n\n### getEnablementState\n\nOutput only. The effective state of enablement for the module at the given\nlevel of the hierarchy.\n\n### setEnablementState\n\nOutput only. The effective state of enablement for the module at the given\nlevel of the hierarchy.\n\n### getDisplayName\n\nOutput only. The display name for the custom module. The name must be\nbetween 1 and 128 characters, start with a lowercase letter, and contain\nalphanumeric characters or underscores only.\n\n### setDisplayName\n\nOutput only. The display name for the custom module. The name must be\nbetween 1 and 128 characters, start with a lowercase letter, and contain\nalphanumeric characters or underscores only."]]
