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

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

Request message for CreateAuditSchedule.

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

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Project or folder that this audit schedule is for, in one of the following formats: * * projects/{project}/locations/{location} * * folders/{folder}/locations/{location}
↳ audit_schedule AuditSchedule

Required. Audit schedule to create.
↳ audit_schedule_id string

Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.
↳ validate_only bool

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

getParent

Required. Project or folder that this audit schedule is for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
Returns
Type Description
string

setParent

Required. Project or folder that this audit schedule is for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
Parameter
Name Description
var string
Returns
Type Description
$this

getAuditSchedule

Required. Audit schedule to create.

Returns
Type Description
AuditSchedule|null

hasAuditSchedule

clearAuditSchedule

setAuditSchedule

Required. Audit schedule to create.

Parameter
Name Description
var AuditSchedule
Returns
Type Description
$this

getAuditScheduleId

Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.

Returns
Type Description
string

setAuditScheduleId

Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. If true, only validates the request and does not create 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 create 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
parent string

Required. Project or folder that this audit schedule is for, in one of the following formats:

    • projects/{project}/locations/{location}
    • folders/{folder}/locations/{location} Please see AuditManagerClient::folderLocationName() for help formatting this field.
auditSchedule AuditSchedule

Required. Audit schedule to create.
auditScheduleId string

Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.
Returns
Type Description
CreateAuditScheduleRequest