Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class EffectiveSecurityHealthAnalyticsCustomModule.
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 an ancestor organization or folder, then
the enablement state is set to the value that is effective in the parent, not
to INHERITED. For example, if the module is enabled in an organization or
folder, then the effective enablement state for the module is ENABLED in
all descendant folders or projects.
Generated from protobuf message google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule
Namespace
Google \ Cloud \ SecurityCenterManagement \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The full resource name of the custom module, in one of the following formats: * * organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module} * * folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module} * * projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}
Output only. The user-specified configuration for the module.
↳ enablement_state
int
Output only. The effective enablement state 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
Identifier. The full resource name of the custom module, in one of the
following formats:
Output only. The effective enablement state for the module at the given
level of the hierarchy.
Returns
Type
Description
int
setEnablementState
Output only. The effective enablement state for the module at the given
level of the hierarchy.
Parameter
Name
Description
var
int
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-04 UTC."],[],[],null,["# Google Cloud Security Center Management V1 Client - Class EffectiveSecurityHealthAnalyticsCustomModule (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-securitycentermanagement/latest/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.2.0](/php/docs/reference/cloud-securitycentermanagement/1.2.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.1.3](/php/docs/reference/cloud-securitycentermanagement/1.1.3/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.0.0](/php/docs/reference/cloud-securitycentermanagement/1.0.0/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.3.2](/php/docs/reference/cloud-securitycentermanagement/0.3.2/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.2.7](/php/docs/reference/cloud-securitycentermanagement/0.2.7/V1.EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.1.0](/php/docs/reference/cloud-securitycentermanagement/0.1.0/V1.EffectiveSecurityHealthAnalyticsCustomModule) \nReference documentation and code samples for the Google Cloud Security Center Management V1 Client class EffectiveSecurityHealthAnalyticsCustomModule.\n\nThe representation of a Security Health Analytics custom module at a\nspecified level of the resource hierarchy: organization, folder, or project.\n\nIf a custom module is inherited from an ancestor organization or folder, then\nthe enablement state is set to the value that is effective in the parent, not\nto `INHERITED`. For example, if the module is enabled in an organization or\nfolder, then the effective enablement state for the module is `ENABLED` in\nall descendant folders or projects.\n\nGenerated from protobuf message `google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ SecurityCenterManagement \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. The full resource name of the custom module, in one of the\nfollowing formats:\n\n- `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\n- `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\n- `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\n\n### setName\n\nIdentifier. The full resource name of the custom module, in one of the\nfollowing formats:\n\n- `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\n- `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\n- `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`\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 enablement state for the module at the given\nlevel of the hierarchy.\n\n### setEnablementState\n\nOutput only. The effective enablement state 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."]]
