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

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

Request message for GenerateAuditScopeReport.

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

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. Project or folder that the audit scope report is generated for, in one of the following formats: * * projects/{project}/locations/{location} * * folders/{folder}/locations/{location} * * organizations/{organization}/locations/{location}
↳ compliance_standard string

Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the compliance_framework field instead.
↳ report_format int

Required. Format for the audit scope report.
↳ compliance_framework string

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.
↳ validate_only bool

Optional. If true, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * * Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs. * * User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests. * * CI/CD & Automation: Test your scripts, permissions, and parameters safely without consuming resource quotas.

getScope

Required. Project or folder that the audit scope 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

Required. Project or folder that the audit scope 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

getComplianceStandard

Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

Use the compliance_framework field instead.

Returns
Type Description
string

setComplianceStandard

Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

Use the compliance_framework field instead.

Parameter
Name Description
var string
Returns
Type Description
$this

getReportFormat

Required. Format for the audit scope report.

Returns
Type Description
int Enum of type AuditScopeReportFormat.

setReportFormat

Required. Format for the audit scope report.

Parameter
Name Description
var int

Enum of type AuditScopeReportFormat.

Returns
Type Description
$this

getComplianceFramework

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

Returns
Type Description
string

setComplianceFramework

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. If true, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

  • Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
  • User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
  • CI/CD & Automation: Test your scripts, permissions, and parameters safely without consuming resource quotas.
Returns
Type Description
bool

setValidateOnly

Optional. If true, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

  • Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
  • User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
  • CI/CD & Automation: Test your scripts, permissions, and parameters safely without consuming resource quotas.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
scope string

Required. Project or folder that the audit scope report is generated for, in one of the following formats:

    • projects/{project}/locations/{location}
    • folders/{folder}/locations/{location}
    • organizations/{organization}/locations/{location}
complianceStandard string

Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

Use the compliance_framework field instead.
reportFormat int

Required. Format for the audit scope report. For allowed values, use constants defined on GenerateAuditScopeReportRequest\AuditScopeReportFormat
Returns
Type Description
GenerateAuditScopeReportRequest