Interface GenerateAuditScopeReportRequestOrBuilder (0.17.0) 

public interface GenerateAuditScopeReportRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getComplianceFramework()

public abstract String getComplianceFramework()

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

string compliance_framework = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The complianceFramework.

getComplianceFrameworkBytes()

public abstract ByteString getComplianceFrameworkBytes()

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

string compliance_framework = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for complianceFramework.

getComplianceStandard() (deprecated)

public abstract String getComplianceStandard()

Deprecated. google.cloud.auditmanager.v1.GenerateAuditScopeReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=420

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

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The complianceStandard.

getComplianceStandardBytes() (deprecated)

public abstract ByteString getComplianceStandardBytes()

Deprecated. google.cloud.auditmanager.v1.GenerateAuditScopeReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=420

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

Use the compliance_framework field instead.

string compliance_standard = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for complianceStandard.

getReportFormat()

public abstract GenerateAuditScopeReportRequest.AuditScopeReportFormat getReportFormat()

Required. Format for the audit scope report.

.google.cloud.auditmanager.v1.GenerateAuditScopeReportRequest.AuditScopeReportFormat report_format = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GenerateAuditScopeReportRequest.AuditScopeReportFormat

The reportFormat.

getReportFormatValue()

public abstract int getReportFormatValue()

Required. Format for the audit scope report.

.google.cloud.auditmanager.v1.GenerateAuditScopeReportRequest.AuditScopeReportFormat report_format = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reportFormat.

getScope()

public abstract String 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}

string scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The scope.

getScopeBytes()

public abstract ByteString getScopeBytes()

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}

string scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for scope.

getValidateOnly()

public abstract boolean 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.

bool validate_only = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.