Audit Manager V1 API - Class Google::Cloud::AuditManager::V1::GenerateAuditReportRequest (v1.2.0)

Reference documentation and code samples for the Audit Manager V1 API class Google::Cloud::AuditManager::V1::GenerateAuditReportRequest.

Request message for GenerateAuditReport.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#compliance_framework

def compliance_framework() -> ::String
Returns
  • (::String) — Required. The framework that's used for the audit report. For example, NIST_800_53.

#compliance_framework=

def compliance_framework=(value) -> ::String
Parameter
  • value (::String) — Required. The framework that's used for the audit report. For example, NIST_800_53.
Returns
  • (::String) — Required. The framework that's used for the audit report. For example, NIST_800_53.

#compliance_standard

def compliance_standard() -> ::String
Returns
  • (::String) — Optional. Deprecated. Compliance standard for the audit report.

    Use the compliance_framework field instead.

#compliance_standard=

def compliance_standard=(value) -> ::String
Parameter
  • value (::String) — Optional. Deprecated. Compliance standard for the audit report.

    Use the compliance_framework field instead.

Returns
  • (::String) — Optional. Deprecated. Compliance standard for the audit report.

    Use the compliance_framework field instead.

#gcs_uri

def gcs_uri() -> ::String
Returns
  • (::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.

#gcs_uri=

def gcs_uri=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#report_format

def report_format() -> ::Google::Cloud::AuditManager::V1::GenerateAuditReportRequest::AuditReportFormat
Returns

#report_format=

def report_format=(value) -> ::Google::Cloud::AuditManager::V1::GenerateAuditReportRequest::AuditReportFormat
Parameter
Returns

#scope

def scope() -> ::String
Returns
  • (::String) —

    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}

#scope=

def scope=(value) -> ::String
Parameter
  • value (::String) —

    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
  • (::String) —

    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}

#validate_only

def validate_only() -> ::Boolean
Returns
  • (::Boolean) —

    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.

#validate_only=

def validate_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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
  • (::Boolean) —

    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.