Google Cloud Security Center Management V1 Client - Class CustomConfig (0.1.0)

Version 0.1.0

• 1.1.2 (latest)
• 1.1.1
• 1.0.0
• 0.3.2
• 0.2.7
• 0.1.0

Reference documentation and code samples for the Google Cloud Security Center Management 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.securitycentermanagement.v1.CustomConfig

Namespace

Google \ Cloud \ SecurityCenterManagement \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ predicate	Google\Type\Expr Optional. The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
↳ custom_output	Google\Cloud\SecurityCenterManagement\V1\CustomConfig\CustomOutputSpec Optional. Custom output properties.
↳ resource_selector	Google\Cloud\SecurityCenterManagement\V1\CustomConfig\ResourceSelector Optional. The CAI resource types that the custom module operates on (see go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to 5 resource types.
↳ severity	int Optional. The severity to assign to findings generated by the module.
↳ description	string Optional. 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 Optional. 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

Optional. The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.

Returns
Type	Description
Google\Type\Expr|null

hasPredicate

clearPredicate

setPredicate

Optional. The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.

Parameter
Name	Description
var	Google\Type\Expr

Returns
Type	Description
$this

getCustomOutput

Optional. Custom output properties.

Returns
Type	Description
Google\Cloud\SecurityCenterManagement\V1\CustomConfig\CustomOutputSpec|null

hasCustomOutput

clearCustomOutput

setCustomOutput

Optional. Custom output properties.

Parameter
Name	Description
var	Google\Cloud\SecurityCenterManagement\V1\CustomConfig\CustomOutputSpec

Returns
Type	Description
$this

getResourceSelector

Optional. The CAI resource types that the custom module operates on (see go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to 5 resource types.

Returns
Type	Description
Google\Cloud\SecurityCenterManagement\V1\CustomConfig\ResourceSelector|null

hasResourceSelector

clearResourceSelector

setResourceSelector

Optional. The CAI resource types that the custom module operates on (see go/gcp-cai-doc/supported-asset-types). Each custom module can specify up to 5 resource types.

Parameter
Name	Description
var	Google\Cloud\SecurityCenterManagement\V1\CustomConfig\ResourceSelector

Returns
Type	Description
$this

getSeverity

Optional. The severity to assign to findings generated by the module.

Returns
Type	Description
int

setSeverity

Optional. The severity to assign to findings generated by the module.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDescription

Optional. 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.

Returns
Type	Description
string

setDescription

Optional. 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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRecommendation

Optional. 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.

Returns
Type	Description
string

setRecommendation

Optional. 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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this