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

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

Request message for GenerateAuditScopeReport.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#compliance_framework

def compliance_framework() -> ::String
Returns
  • (::String) — Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

#compliance_framework=

def compliance_framework=(value) -> ::String
Parameter
  • value (::String) — Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.
Returns
  • (::String) — Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

#compliance_standard

def compliance_standard() -> ::String
Returns
  • (::String) — Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

    Use the compliance_framework field instead.

#compliance_standard=

def compliance_standard=(value) -> ::String
Parameter
  • value (::String) — Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

    Use the compliance_framework field instead.

Returns
  • (::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

def report_format() -> ::Google::Cloud::AuditManager::V1::GenerateAuditScopeReportRequest::AuditScopeReportFormat
Returns

#report_format=

def report_format=(value) -> ::Google::Cloud::AuditManager::V1::GenerateAuditScopeReportRequest::AuditScopeReportFormat
Parameter
Returns

#scope

def scope() -> ::String
Returns
  • (::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}

#scope=

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

#validate_only

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

    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.

#validate_only=

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

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

    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.