Google Cloud Security Command Center V1 Client - Class SecurityHealthAnalyticsCustomModule (1.31.0)

Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class SecurityHealthAnalyticsCustomModule.

Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.

Generated from protobuf message google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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.
↳ display_name 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.
↳ enablement_state int

The enablement state of the custom module.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the custom module was last updated.
↳ last_editor string

Output only. The editor that last updated the custom module.
↳ ancestor_module 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.
↳ custom_config Google\Cloud\SecurityCenter\V1\CustomConfig

The user specified custom configuration for the module.

getName

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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.

Returns
Type Description
string

setDisplayName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnablementState

The enablement state of the custom module.

Returns
Type Description
int

setEnablementState

The enablement state of the custom module.

Parameter
Name Description
var int
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the custom module was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the custom module was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastEditor

Output only. The editor that last updated the custom module.

Returns
Type Description
string

setLastEditor

Output only. The editor that last updated the custom module.

Parameter
Name Description
var string
Returns
Type Description
$this

getAncestorModule

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.

Returns
Type Description
string

setAncestorModule

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCustomConfig

The user specified custom configuration for the module.

Returns
Type Description
Google\Cloud\SecurityCenter\V1\CustomConfig|null

hasCustomConfig

clearCustomConfig

setCustomConfig

The user specified custom configuration for the module.

Parameter
Name Description
var Google\Cloud\SecurityCenter\V1\CustomConfig
Returns
Type Description
$this