Interface CreateAuditScheduleRequestOrBuilder (0.17.0)

public interface CreateAuditScheduleRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuditSchedule()

public abstract AuditSchedule getAuditSchedule()

Required. Audit schedule to create.

.google.cloud.auditmanager.v1.AuditSchedule audit_schedule = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuditSchedule

The auditSchedule.

getAuditScheduleId()

public abstract String getAuditScheduleId()

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

string audit_schedule_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The auditScheduleId.

getAuditScheduleIdBytes()

public abstract ByteString getAuditScheduleIdBytes()

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

string audit_schedule_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for auditScheduleId.

getAuditScheduleOrBuilder()

public abstract AuditScheduleOrBuilder getAuditScheduleOrBuilder()

Required. Audit schedule to create.

.google.cloud.auditmanager.v1.AuditSchedule audit_schedule = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuditScheduleOrBuilder

getParent()

public abstract String 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}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getValidateOnly()

public abstract boolean 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.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasAuditSchedule()

public abstract boolean hasAuditSchedule()

Required. Audit schedule to create.

.google.cloud.auditmanager.v1.AuditSchedule audit_schedule = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the auditSchedule field is set.