Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class CustomConfig.
Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.
Generated from protobuf message google.cloud.securitycenter.v1.CustomConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ predicate
Google\Type\Expr
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
↳ custom_output
↳ resource_selector
Google\Cloud\SecurityCenter\V1\CustomConfig\ResourceSelector
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
↳ severity
int
The severity to assign to findings generated by the module.
↳ description
string
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
↳ recommendation
string
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps
property of the finding JSON.
getPredicate
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
hasPredicate
clearPredicate
setPredicate
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
$this
getCustomOutput
Custom output properties.
hasCustomOutput
clearCustomOutput
setCustomOutput
Custom output properties.
$this
getResourceSelector
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
hasResourceSelector
clearResourceSelector
setResourceSelector
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
$this
getSeverity
The severity to assign to findings generated by the module.
int
setSeverity
The severity to assign to findings generated by the module.
var
int
$this
getDescription
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
string
setDescription
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
var
string
$this
getRecommendation
An explanation of the recommended steps that security teams can take to
resolve the detected issue. This explanation is returned with each finding
generated by this module in the nextSteps
property of the finding JSON.
string
setRecommendation
An explanation of the recommended steps that security teams can take to
resolve the detected issue. This explanation is returned with each finding
generated by this module in the nextSteps
property of the finding JSON.
var
string
$this