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

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

The details for control compliance.

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

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ control string

The name of the control.

↳ display_name string

The display name of the control.

↳ description string

The description of the control.

↳ overall_evaluation_state int

Output only. The overall evaluation status of the control.

↳ total_findings_count int

The total number of findings for the control.

↳ compliance_frameworks array

The list of compliance frameworks that the control belongs to.

↳ similar_controls array<SimilarControls>

The list of similar controls.

↳ cloud_control_reports array<CloudControlReport>

The list of cloud control reports.

↳ control_responsibility_type int

The responsibility type for the control.

↳ is_fake_control bool

Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.

↳ name string

Identifier. The name of the control compliance summary.

getControl

The name of the control.

Returns
Type Description
string

setControl

The name of the control.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the control.

Returns
Type Description
string

setDisplayName

The display name of the control.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

The description of the control.

Returns
Type Description
string

setDescription

The description of the control.

Parameter
Name Description
var string
Returns
Type Description
$this

getOverallEvaluationState

Output only. The overall evaluation status of the control.

Returns
Type Description
int Enum of type EvaluationState.

setOverallEvaluationState

Output only. The overall evaluation status of the control.

Parameter
Name Description
var int

Enum of type EvaluationState.

Returns
Type Description
$this

getTotalFindingsCount

The total number of findings for the control.

Returns
Type Description
int

setTotalFindingsCount

The total number of findings for the control.

Parameter
Name Description
var int
Returns
Type Description
$this

getComplianceFrameworks

The list of compliance frameworks that the control belongs to.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setComplianceFrameworks

The list of compliance frameworks that the control belongs to.

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

getSimilarControls

The list of similar controls.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSimilarControls

The list of similar controls.

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

getCloudControlReports

The list of cloud control reports.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCloudControlReports

The list of cloud control reports.

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

getControlResponsibilityType

The responsibility type for the control.

Returns
Type Description
int Enum of type RegulatoryControlResponsibilityType.

setControlResponsibilityType

The responsibility type for the control.

Parameter
Name Description
var int

Enum of type RegulatoryControlResponsibilityType.

Returns
Type Description
$this

getIsFakeControl

Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.

Returns
Type Description
bool

setIsFakeControl

Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.

Parameter
Name Description
var bool
Returns
Type Description
$this

getName

Identifier. The name of the control compliance summary.

Returns
Type Description
string

setName

Identifier. The name of the control compliance summary.

Parameter
Name Description
var string
Returns
Type Description
$this