Console
    Start free

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

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

    The ReportGenerationProgress is part of google.longrunning.Operation returned to the client for every GetOperation request.

    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. The current state of execution for report generation.

    ↳ failure_reason
    string

    Output only. States the reason of failure during the audit report generation process. This field is set only if the state attribute is OPERATION_STATE_FAILED.

    ↳ evaluation_percent_complete
    float

    Shows the progress of the CESS service evaluation process. The progress is defined in terms of percentage complete and is being fetched from the CESS service.

    ↳ report_generation_percent_complete
    float

    Shows the report generation progress of the CESS Result Processor Service. The // progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_generation_in_progress is non zero then evaluation_percent_complete will be 100%.

    ↳ report_uploading_percent_complete
    float

    Shows the report uploading progress of the CESS Result Processor Service. The progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_uploading_in_progress is non zero then evaluation_percent_complete and report_generation_percent_complete will be 100%.

    ↳ destination_gcs_bucket
    string

    Output only. The Cloud Storage bucket where the audit report will be uploaded once the evaluation process is completed.

    ↳ audit_report
    string

    Output only. The name of the audit report.

    getState

    Output only. The current state of execution for report generation.

    Returns
    Type
    Description
    int
    Enum of type OperationState .

    setState

    Output only. The current state of execution for report generation.

    Parameter
    Name
    Description
    var
    int

    Enum of type OperationState .

    Returns
    Type
    Description
    $this

    getFailureReason

    Output only. States the reason of failure during the audit report generation process. This field is set only if the state attribute is OPERATION_STATE_FAILED.

    Returns
    Type
    Description
    string

    setFailureReason

    Output only. States the reason of failure during the audit report generation process. This field is set only if the state attribute is OPERATION_STATE_FAILED.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEvaluationPercentComplete

    Shows the progress of the CESS service evaluation process. The progress is defined in terms of percentage complete and is being fetched from the CESS service.

    Returns
    Type
    Description
    float

    setEvaluationPercentComplete

    Shows the progress of the CESS service evaluation process. The progress is defined in terms of percentage complete and is being fetched from the CESS service.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getReportGenerationPercentComplete

    Shows the report generation progress of the CESS Result Processor Service.

    The // progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_generation_in_progress is non zero then evaluation_percent_complete will be 100%.

    Returns
    Type
    Description
    float

    setReportGenerationPercentComplete

    Shows the report generation progress of the CESS Result Processor Service.

    The // progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_generation_in_progress is non zero then evaluation_percent_complete will be 100%.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getReportUploadingPercentComplete

    Shows the report uploading progress of the CESS Result Processor Service.

    The progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_uploading_in_progress is non zero then evaluation_percent_complete and report_generation_percent_complete will be 100%.

    Returns
    Type
    Description
    float

    setReportUploadingPercentComplete

    Shows the report uploading progress of the CESS Result Processor Service.

    The progress is defined in terms of percentage complete and is being fetched from the CESS service. If report_uploading_in_progress is non zero then evaluation_percent_complete and report_generation_percent_complete will be 100%.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getDestinationGcsBucket

    Output only. The Cloud Storage bucket where the audit report will be uploaded once the evaluation process is completed.

    Returns
    Type
    Description
    string

    setDestinationGcsBucket

    Output only. The Cloud Storage bucket where the audit report will be uploaded once the evaluation process is completed.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAuditReport

    Output only. The name of the audit report.

    Returns
    Type
    Description
    string

    setAuditReport

    Output only. The name of the audit report.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: