Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class GenerateAuditReportRequest.
Request message for GenerateAuditReport.
Generated from protobuf message google.cloud.auditmanager.v1.GenerateAuditReportRequest
Namespace
Google \ Cloud \ AuditManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ gcs_uri |
string
URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process. |
↳ scope |
string
Required. Organization, folder, or project that the audit applies to, in one of the following formats: * * |
↳ compliance_standard |
string
Optional. Deprecated. Compliance standard for the audit report. Use the |
↳ report_format |
int
Required. Format for the audit report. |
↳ compliance_framework |
string
Required. The framework that's used for the audit report. For example, |
↳ validate_only |
bool
Optional. If |
getGcsUri
URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasGcsUri
setGcsUri
URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
Required. Organization, folder, or project that the audit applies to, in one of the following formats:
projects/{project}/locations/{location}folders/{folder}/locations/{location}organizations/{organization}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setScope
Required. Organization, folder, or project that the audit applies to, 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. Compliance standard for the audit report.
Use the compliance_framework field instead.
| Returns | |
|---|---|
| Type | Description |
string |
|
setComplianceStandard
Optional. Deprecated. Compliance standard for the audit report.
Use the compliance_framework field instead.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReportFormat
Required. Format for the audit report.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AuditReportFormat. |
setReportFormat
Required. Format for the audit report.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AuditReportFormat. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComplianceFramework
Required. The framework that's used for the audit report. For example,
NIST_800_53.
| Returns | |
|---|---|
| Type | Description |
string |
|
setComplianceFramework
Required. The framework that's used for the audit report. 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 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 triggering expensive Long-Running Operations (LROs) or consuming resource quotas.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setValidateOnly
Optional. If true, only validates the request and does not generate the
audit 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 triggering expensive Long-Running Operations (LROs) or consuming resource quotas.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestination
| Returns | |
|---|---|
| Type | Description |
string |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
scope |
string
Required. Organization, folder, or project that the audit applies to, in one of the following formats:
|
gcsUri |
string
URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process. |
complianceStandard |
string
Optional. Deprecated. Compliance standard for the audit report. Use the |
reportFormat |
int
Required. Format for the audit report. For allowed values, use constants defined on GenerateAuditReportRequest\AuditReportFormat |
| Returns | |
|---|---|
| Type | Description |
GenerateAuditReportRequest |
|