Google Cloud Audit Manager V1 Client - Class AuditReport (0.4.1)

Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class AuditReport.

An audit report.

Generated from protobuf message google.cloud.auditmanager.v1.AuditReport

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. Name of the audit report, in one of the following formats: * * projects/{project}/locations/{location}/auditReports/{audit_report} * * folders/{folder}/locations/{location}/auditReports/{audit_report} * * organizations/{organization}/locations/{location}/auditReports/{audit_report}
↳ report_summary ReportSummary

Output only. Report summary that includes information about compliance and violation counts.
↳ operation_id string

Output only. Client operation ID for the audit report.
↳ destination_details DestinationDetails

Output only. Cloud Storage bucket where the audit report is uploaded to.
↳ compliance_standard string

Output only. Deprecated. Compliance standard to be audited against. Use the compliance_framework field instead.
↳ scope string

Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * * projects/{project}/locations/{location} * * folders/{folder}/locations/{location} * * organizations/{organization}/locations/{location}
↳ create_time Google\Protobuf\Timestamp

Output only. Creation time of the audit report.
↳ control_details array<ControlDetails>

Output only. Overall status of the controls.
↳ report_generation_state int

Output only. State of audit report generation.
↳ compliance_framework string

Output only. Compliance framework to use for the audit report. For example, CIS_GCP_FOUNDATIONS_V1_2_0.
↳ scope_id string

Output only. Project number, folder ID, or organization ID that the audit report was generated for.

getName

Identifier. Name of the audit report, in one of the following formats:

  • projects/{project}/locations/{location}/auditReports/{audit_report}
  • folders/{folder}/locations/{location}/auditReports/{audit_report}
  • organizations/{organization}/locations/{location}/auditReports/{audit_report}
Returns
Type Description
string

setName

Identifier. Name of the audit report, in one of the following formats:

  • projects/{project}/locations/{location}/auditReports/{audit_report}
  • folders/{folder}/locations/{location}/auditReports/{audit_report}
  • organizations/{organization}/locations/{location}/auditReports/{audit_report}
Parameter
Name Description
var string
Returns
Type Description
$this

getReportSummary

Output only. Report summary that includes information about compliance and violation counts.

Returns
Type Description
ReportSummary|null

hasReportSummary

clearReportSummary

setReportSummary

Output only. Report summary that includes information about compliance and violation counts.

Parameter
Name Description
var ReportSummary
Returns
Type Description
$this

getOperationId

Output only. Client operation ID for the audit report.

Returns
Type Description
string

setOperationId

Output only. Client operation ID for the audit report.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationDetails

Output only. Cloud Storage bucket where the audit report is uploaded to.

Returns
Type Description
DestinationDetails|null

hasDestinationDetails

clearDestinationDetails

setDestinationDetails

Output only. Cloud Storage bucket where the audit report is uploaded to.

Parameter
Name Description
var DestinationDetails
Returns
Type Description
$this

getComplianceStandard

Output only. Deprecated. Compliance standard to be audited against.

Use the compliance_framework field instead.

Returns
Type Description
string

setComplianceStandard

Output only. Deprecated. Compliance standard to be audited against.

Use the compliance_framework field instead.

Parameter
Name Description
var string
Returns
Type Description
$this

getScope

Output only. Organization, folder, or project that the report is generated for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
  • organizations/{organization}/locations/{location}
Returns
Type Description
string

setScope

Output only. Organization, folder, or project that the report is generated for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
  • organizations/{organization}/locations/{location}
Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Creation time of the audit report.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of the audit report.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getControlDetails

Output only. Overall status of the controls.

Returns
Type Description
Google\Protobuf\RepeatedField<ControlDetails>

setControlDetails

Output only. Overall status of the controls.

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

getReportGenerationState

Output only. State of audit report generation.

Returns
Type Description
int Enum of type ReportGenerationState.

setReportGenerationState

Output only. State of audit report generation.

Parameter
Name Description
var int

Enum of type ReportGenerationState.

Returns
Type Description
$this

getComplianceFramework

Output only. Compliance framework to use for the audit report. For example, CIS_GCP_FOUNDATIONS_V1_2_0.

Returns
Type Description
string

setComplianceFramework

Output only. Compliance framework to use for the audit report. For example, CIS_GCP_FOUNDATIONS_V1_2_0.

Parameter
Name Description
var string
Returns
Type Description
$this

getScopeId

Output only. Project number, folder ID, or organization ID that the audit report was generated for.

Returns
Type Description
string

setScopeId

Output only. Project number, folder ID, or organization ID that the audit report was generated for.

Parameter
Name Description
var string
Returns
Type Description
$this