public interface GenerateAuditReportRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getComplianceFramework()
public abstract String getComplianceFramework() Required. The framework that's used for the audit report. 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. The framework that's used for the audit report. 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.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478
Optional. Deprecated. Compliance standard for the audit report.
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.GenerateAuditReportRequest.compliance_standard is deprecated. See google/cloud/auditmanager/v1/auditmanager.proto;l=478
Optional. Deprecated. Compliance standard for the audit report.
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. |
getDestinationCase()
public abstract GenerateAuditReportRequest.DestinationCase getDestinationCase()| Returns | |
|---|---|
| Type | Description |
GenerateAuditReportRequest.DestinationCase |
|
getGcsUri()
public abstract String 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.
string gcs_uri = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The gcsUri. |
getGcsUriBytes()
public abstract ByteString getGcsUriBytes()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.
string gcs_uri = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for gcsUri. |
getReportFormat()
public abstract GenerateAuditReportRequest.AuditReportFormat getReportFormat()Required. Format for the audit report.
.google.cloud.auditmanager.v1.GenerateAuditReportRequest.AuditReportFormat report_format = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
GenerateAuditReportRequest.AuditReportFormat |
The reportFormat. |
getReportFormatValue()
public abstract int getReportFormatValue()Required. Format for the audit report.
.google.cloud.auditmanager.v1.GenerateAuditReportRequest.AuditReportFormat 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. 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}
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The scope. |
getScopeBytes()
public abstract ByteString getScopeBytes()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}
string scope = 1 [(.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 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.
bool validate_only = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The validateOnly. |
hasGcsUri()
public abstract boolean hasGcsUri()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.
string gcs_uri = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gcsUri field is set. |