Google Cloud Security Compliance V1 Client - Class CloudControl (0.1.0)

Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class CloudControl.

A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit).

CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).

Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.CloudControl

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Identifier. The resource name of the cloud control. Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}
`↳ major_revision_id`	`int\|string` Output only. Major revision of the cloud control incremented in ascending order.
`↳ description`	`string` Optional. A description of the cloud control. The maximum length is 2000 characters.
`↳ display_name`	`string` Optional. The display name of the cloud control. The maximum length is 200 characters.
`↳ supported_enforcement_modes`	`array` Output only. The supported enforcement mode of the cloud control. Default is DETECTIVE.
`↳ parameter_spec`	`array<ParameterSpec>` Optional. The parameter spec of the cloud control.
`↳ rules`	`array<Rule>` Optional. The Policy to be enforced to prevent/detect resource non-compliance.
`↳ severity`	`int` Optional. The severity of findings generated by the cloud control.
`↳ finding_category`	`string` Optional. The finding_category of the cloud control. The maximum length is 255 characters.
`↳ supported_cloud_providers`	`array` Optional. cloud providers supported
`↳ related_frameworks`	`array` Output only. The Frameworks that include this CloudControl
`↳ remediation_steps`	`string` Optional. The remediation steps for the findings generated by the cloud control. The maximum length is 400 characters.
`↳ categories`	`array` Optional. The categories of the cloud control.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The last updated time of the cloud control. The create_time is used because a new CC is created whenever we update an existing CC.
`↳ supported_target_resource_types`	`array` Optional. target resource types supported by the CloudControl.

getName

Required. Identifier. The resource name of the cloud control.

Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}

Returns
Type	Description
`string`

setName

Required. Identifier. The resource name of the cloud control.

Format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMajorRevisionId

Output only. Major revision of the cloud control incremented in ascending order.

Returns
Type	Description
`int\|string`

setMajorRevisionId

Output only. Major revision of the cloud control incremented in ascending order.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getDescription

Optional. A description of the cloud control. The maximum length is 2000 characters.

Returns
Type	Description
`string`

setDescription

Optional. A description of the cloud control. The maximum length is 2000 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Optional. The display name of the cloud control. The maximum length is 200 characters.

Returns
Type	Description
`string`

setDisplayName

Optional. The display name of the cloud control. The maximum length is 200 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSupportedEnforcementModes

Output only. The supported enforcement mode of the cloud control. Default is DETECTIVE.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSupportedEnforcementModes

Output only. The supported enforcement mode of the cloud control. Default is DETECTIVE.

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getParameterSpec

Optional. The parameter spec of the cloud control.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setParameterSpec

Optional. The parameter spec of the cloud control.

Parameter
Name	Description
`var`	`array<ParameterSpec>`

Returns
Type	Description
`$this`

getRules

Optional. The Policy to be enforced to prevent/detect resource non-compliance.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRules

Optional. The Policy to be enforced to prevent/detect resource non-compliance.

Parameter
Name	Description
`var`	`array<Rule>`

Returns
Type	Description
`$this`

getSeverity

Optional. The severity of findings generated by the cloud control.

Returns
Type	Description
`int`	Enum of type Severity.

setSeverity

Optional. The severity of findings generated by the cloud control.

Parameter
Name	Description
`var`	`int` Enum of type Severity.

Returns
Type	Description
`$this`

getFindingCategory

Optional. The finding_category of the cloud control. The maximum length is 255 characters.

Returns
Type	Description
`string`

setFindingCategory

Optional. The finding_category of the cloud control. The maximum length is 255 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSupportedCloudProviders

Optional. cloud providers supported

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSupportedCloudProviders

Optional. cloud providers supported

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getRelatedFrameworks

Output only. The Frameworks that include this CloudControl

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRelatedFrameworks