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
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}" |
↳ custom_config |
Google\Cloud\SecurityCenter\V1\CustomConfig
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V1\CustomConfig|null | |
hasCustomConfig
clearCustomConfig
setCustomConfig
Output only. The user-specified configuration for the module.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V1\CustomConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnablementState
Output only. The effective state of enablement for the module at the given level of the hierarchy.
| Returns | |
|---|---|
| Type | Description |
int | |
setEnablementState
Output only. The effective state of enablement 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |