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

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

Request message for UpdateAuditSchedule.

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

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ audit_schedule AuditSchedule

Required. Audit schedule to update.
↳ update_mask Google\Protobuf\FieldMask

Optional. List of fields to update.
↳ validate_only bool

Optional. If true, only validates the request and does not update the audit schedule. 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.

getAuditSchedule

Required. Audit schedule to update.

Returns
Type Description
AuditSchedule|null

hasAuditSchedule

clearAuditSchedule

setAuditSchedule

Required. Audit schedule to update.

Parameter
Name Description
var AuditSchedule
Returns
Type Description
$this

getUpdateMask

Optional. List of fields to update.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. List of fields to update.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getValidateOnly

Optional. If true, only validates the request and does not update the audit schedule. 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
Type Description
bool

setValidateOnly

Optional. If true, only validates the request and does not update the audit schedule. 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.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
auditSchedule AuditSchedule

Required. Audit schedule to update.
updateMask Google\Protobuf\FieldMask

Optional. List of fields to update.
Returns
Type Description
UpdateAuditScheduleRequest