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

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

Request message for EnrollResource.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#destinations

def destinations() -> ::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>
Returns
  • (::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>) — Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

    When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

#destinations=

def destinations=(value) -> ::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>
Parameter
  • value (::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>) — Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

    When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

Returns
  • (::Array<::Google::Cloud::AuditManager::V1::EnrollResourceRequest::EligibleDestination>) — Required. Cloud Storage buckets that you can upload your audit reports to during the audit process.

    When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.

#scope

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

    Required. Organization, folder, or project to enroll in Audit Manager, 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 to enroll in Audit Manager, 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 to enroll in Audit Manager, 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 enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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 enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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 enroll the resource. This executes standard request validation (such as schema, IAM, and destination 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.