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

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

A cloud control is a set of rules and associated metadata that you can use to define your organization's security or compliance intent.

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 name of the cloud control, in the format organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id} . The only supported location is global .

↳ major_revision_id
int|string

Output only. The major version of the cloud control, which is incremented in ascending order.

↳ description
string

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

↳ display_name
string

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

↳ supported_enforcement_modes
array

Output only. The supported enforcement modes for the cloud control.

↳ parameter_spec
array< ParameterSpec >

Optional. The parameter specifications for the cloud control.

↳ rules
array< Rule >

Optional. The rules that you can enforce to meet your security or compliance intent.

↳ severity
int

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

↳ finding_category
string

Optional. The finding category for the cloud control findings. The maximum length is 255 characters.

↳ supported_cloud_providers
array

Optional. The supported cloud providers.

↳ related_frameworks
array

Output only. The frameworks that include this cloud control.

↳ remediation_steps
string

Optional. The remediation steps for the cloud control findings. The maximum length is 400 characters.

↳ categories
array

Optional. The categories for the cloud control.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time that the cloud control was last updated. create_time is used because a new cloud control is created whenever an existing cloud control is updated.

↳ supported_target_resource_types
array

Optional. The target resource types that are supported by the cloud control.

getName

Required. Identifier. The name of the cloud control, in the format organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id} .

The only supported location is global .

Returns
Type
Description
string

setName

Required. Identifier. The name of the cloud control, in the format organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id} .

The only supported location is global .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMajorRevisionId

Output only. The major version of the cloud control, which is incremented in ascending order.

Returns
Type
Description
int|string

setMajorRevisionId

Output only. The major version of the cloud control, which is 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 friendly name of the cloud control. The maximum length is 200 characters.

Returns
Type
Description
string

setDisplayName

Optional. The friendly 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 modes for the cloud control.

Returns
Type
Description

setSupportedEnforcementModes

Output only. The supported enforcement modes for the cloud control.

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this

getParameterSpec

Optional. The parameter specifications for the cloud control.

Returns
Type
Description

setParameterSpec

Optional. The parameter specifications for the cloud control.

Parameter
Name
Description
var
array< ParameterSpec >
Returns
Type
Description
$this

getRules

Optional. The rules that you can enforce to meet your security or compliance intent.

Returns
Type
Description

setRules

Optional. The rules that you can enforce to meet your security or compliance intent.

Parameter
Name
Description
var
array< Rule >
Returns
Type
Description
$this

getSeverity

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

Returns
Type
Description
int
Enum of type Severity .

setSeverity

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

Parameter
Name
Description
var
int

Enum of type Severity .

Returns
Type
Description
$this

getFindingCategory

Optional. The finding category for the cloud control findings. The maximum length is 255 characters.

Returns
Type
Description
string

setFindingCategory

Optional. The finding category for the cloud control findings. The maximum length is 255 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSupportedCloudProviders

Optional. The supported cloud providers.

Returns
Type
Description

setSupportedCloudProviders

Optional. The supported cloud providers.

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this

getRelatedFrameworks

Output only. The frameworks that include this cloud control.

Returns
Type
Description

setRelatedFrameworks

Output only. The frameworks that include this cloud control.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getRemediationSteps

Optional. The remediation steps for the cloud control findings. The maximum length is 400 characters.

Returns
Type
Description
string

setRemediationSteps

Optional. The remediation steps for the cloud control findings. The maximum length is 400 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCategories

Optional. The categories for the cloud control.

Returns
Type
Description

setCategories

Optional. The categories for the cloud control.

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this

getCreateTime

Output only. The time that the cloud control was last updated.

create_time is used because a new cloud control is created whenever an existing cloud control is updated.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time that the cloud control was last updated.

create_time is used because a new cloud control is created whenever an existing cloud control is updated.

Parameter
Name
Description
Returns
Type
Description
$this

getSupportedTargetResourceTypes

Optional. The target resource types that are supported by the cloud control.

Returns
Type
Description

setSupportedTargetResourceTypes

Optional. The target resource types that are supported by the cloud control.

Parameter
Name
Description
var
int[]
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: