Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class FrameworkAudit.
A framework audit.
Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.FrameworkAudit
Namespace
Google \ Cloud \ CloudSecurityCompliance \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Identifier. The name of the framework audit. |
↳ framework_audit_id |
string
Output only. The ID of the framework audit. |
↳ compliance_framework |
string
Output only. The compliance framework used for the audit. |
↳ scope |
string
Output only. The scope of the audit. |
↳ framework_audit_destination |
FrameworkAuditDestination
Required. The destination for the audit reports. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The time that the audit started. |
↳ finish_time |
Google\Protobuf\Timestamp
Output only. The time that the audit finished. |
↳ compliance_state |
int
Output only. The overall compliance state of the audit. |
↳ report_summary |
ReportSummary
Output only. The summary of the report. |
↳ cloud_control_group_audit_details |
array<CloudControlGroupAuditDetails>
Optional. The details for the cloud control groups within this audit. |
↳ cloud_control_audit_details |
array<CloudControlAuditDetails>
Optional. The details for the cloud controls within this audit. |
↳ operation_id |
string
Output only. The ID of the long-running operation. |
↳ state |
int
Output only. The framework audit state of the audit. |
getName
Output only. Identifier. The name of the framework audit.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Identifier. The name of the framework audit.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrameworkAuditId
Output only. The ID of the framework audit.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFrameworkAuditId
Output only. The ID of the framework audit.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComplianceFramework
Output only. The compliance framework used for the audit.
| Returns | |
|---|---|
| Type | Description |
string |
|
setComplianceFramework
Output only. The compliance framework used for the audit.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
Output only. The scope of the audit.
| Returns | |
|---|---|
| Type | Description |
string |
|
setScope
Output only. The scope of the audit.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrameworkAuditDestination
Required. The destination for the audit reports.
| Returns | |
|---|---|
| Type | Description |
FrameworkAuditDestination|null |
|
hasFrameworkAuditDestination
clearFrameworkAuditDestination
setFrameworkAuditDestination
Required. The destination for the audit reports.
| Parameter | |
|---|---|
| Name | Description |
var |
FrameworkAuditDestination
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. The time that the audit started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. The time that the audit started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinishTime
Output only. The time that the audit finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasFinishTime
clearFinishTime
setFinishTime
Output only. The time that the audit finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComplianceState
Output only. The overall compliance state of the audit.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ComplianceState. |
setComplianceState
Output only. The overall compliance state of the audit.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ComplianceState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReportSummary
Output only. The summary of the report.
| Returns | |
|---|---|
| Type | Description |
ReportSummary|null |
|
hasReportSummary
clearReportSummary
setReportSummary
Output only. The summary of the report.
| Parameter | |
|---|---|
| Name | Description |
var |
ReportSummary
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudControlGroupAuditDetails
Optional. The details for the cloud control groups within this audit.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCloudControlGroupAuditDetails
Optional. The details for the cloud control groups within this audit.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CloudControlGroupAuditDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudControlAuditDetails
Optional. The details for the cloud controls within this audit.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCloudControlAuditDetails
Optional. The details for the cloud controls within this audit.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CloudControlAuditDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOperationId
Output only. The ID of the long-running operation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOperationId
Output only. The ID of the long-running operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The framework audit state of the audit.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The framework audit state of the audit.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|