Google Cloud Audit Manager V1 Client - Class EnrollResourceRequest (0.4.1)

Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class EnrollResourceRequest.

Request message for EnrollResource.

Generated from protobuf message google.cloud.auditmanager.v1.EnrollResourceRequest

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ scope 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}
↳ destinations array<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.
↳ validate_only bool

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.

getScope

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
Type Description
string

setScope

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}
Parameter
Name Description
var string
Returns
Type Description
$this

getDestinations

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
Type Description
Google\Protobuf\RepeatedField<EnrollResourceRequest\EligibleDestination>

setDestinations

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.

Parameter
Name Description
var array<EnrollResourceRequest\EligibleDestination>
Returns
Type Description
$this

getValidateOnly

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
Type Description
bool

setValidateOnly

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.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
scope 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}
destinations array<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
Type Description
EnrollResourceRequest