Google Cloud Security Command Center V1 Client - Class CustomConfig (1.21.0)

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

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Cloud\SecurityCenter\V1\CustomConfig\CustomOutputSpec` Custom output properties.
`↳ 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.

Returns
Type	Description
`Google\Type\Expr\|null`

hasPredicate

clearPredicate

setPredicate

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

Custom output properties.

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

hasCustomOutput

clearCustomOutput

setCustomOutput

Custom output properties.

Parameter
Name	Description
`var`	`Google\Cloud\SecurityCenter\V1\CustomConfig\CustomOutputSpec`

Returns
Type	Description
`$this`

getResourceSelector

The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.

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

hasResourceSelector

clearResourceSelector

setResourceSelector

The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.

Parameter
Name	Description
`var`	`Google\Cloud\SecurityCenter\V1\CustomConfig\ResourceSelector`

Returns
Type	Description
`$this`

getSeverity

The severity to assign to findings generated by the module.

Returns
Type	Description
`int`

setSeverity

The severity to assign to findings generated by the module.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

setDescription

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

setRecommendation

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`