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

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

Details about the current status of the report-generation process.

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

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ state`	`int` Output only. Current state of execution for report generation.
`↳ failure_reason`	`string` Output only. Reason for failure during the audit report generation process. This field is set only if the `OperationState` attribute is `OPERATION_STATE_FAILED`.
`↳ evaluation_percent_complete`	`float` Progress of the evaluation process. The progress is defined in terms of percentage complete.
`↳ report_generation_percent_complete`	`float` Report generation progress, defined in terms of percentage complete. Until evaluation is complete, this value is always `0`.
`↳ report_uploading_percent_complete`	`float` Report uploading progress, defined in terms of percentage complete. Until evaluation and report generation are complete, this value is always `0`.
`↳ destination_gcs_bucket`	`string` Output only. Cloud Storage bucket where the audit report is uploaded to after the evaluation process is completed.
`↳ audit_report`	`string` Output only. Name of the audit report.

getState

Output only. Current state of execution for report generation.

Returns
Type	Description
`int`	Enum of type OperationState.

setState

Output only. Current state of execution for report generation.

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

Returns
Type	Description
`$this`

getFailureReason

Output only. Reason for failure during the audit report generation process.

This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

Returns
Type	Description
`string`

setFailureReason

Output only. Reason for failure during the audit report generation process.

This field is set only if the OperationState attribute is OPERATION_STATE_FAILED.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEvaluationPercentComplete

Progress of the evaluation process. The progress is defined in terms of percentage complete.

Returns
Type	Description
`float`

setEvaluationPercentComplete

Progress of the evaluation process. The progress is defined in terms of percentage complete.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getReportGenerationPercentComplete

Report generation progress, defined in terms of percentage complete.

Until evaluation is complete, this value is always 0.

Returns
Type	Description
`float`

setReportGenerationPercentComplete

Report generation progress, defined in terms of percentage complete.

Until evaluation is complete, this value is always 0.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getReportUploadingPercentComplete

Report uploading progress, defined in terms of percentage complete.

Until evaluation and report generation are complete, this value is always 0.

Returns
Type	Description
`float`

setReportUploadingPercentComplete