Audit Manager v1 API - Class AuditSchedule (1.3.0)

public sealed class AuditSchedule : IMessage<AuditSchedule>, IEquatable<AuditSchedule>, IDeepCloneable<AuditSchedule>, IBufferMessage, IMessage

Reference documentation and code samples for the Audit Manager v1 API class AuditSchedule.

An audit schedule, in one of the following formats:

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

Inheritance

object > AuditSchedule

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

AuditSchedule()

public AuditSchedule()

AuditSchedule(AuditSchedule)

public AuditSchedule(AuditSchedule other)
Parameter
Name Description
other AuditSchedule

Properties

AuditScheduleName

public AuditScheduleName AuditScheduleName { get; set; }

AuditScheduleName-typed view over the Name resource name property.

Property Value
Type Description
AuditScheduleName

ComplianceFramework

public string ComplianceFramework { get; set; }

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

Property Value
Type Description
string

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the schedule was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Optional. Display name for the audit schedule.

Property Value
Type Description
string

ErrorMessage

public string ErrorMessage { get; set; }

Output only. Describes the error if the schedule is in an error state.

Property Value
Type Description
string

GcsUri

public string GcsUri { get; set; }

Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is gs://{bucket_name}.

Property Value
Type Description
string

LastTriggerTime

public Timestamp LastTriggerTime { get; set; }

Output only. Timestamp when the audit run was last triggered.

Property Value
Type Description
Timestamp

Name

public string Name { get; set; }

Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}

Property Value
Type Description
string

NextRunTime

public Timestamp NextRunTime { get; set; }

Output only. Calculated timestamp for the next scheduled run.

Property Value
Type Description
Timestamp

ReportFormat

public AuditSchedule.Types.AuditReportFormat ReportFormat { get; set; }

Required. Format for the audit report.

Property Value
Type Description
AuditScheduleTypesAuditReportFormat

ScheduleConfig

public ScheduleConfig ScheduleConfig { get; set; }

Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.

Property Value
Type Description
ScheduleConfig

State

public ScheduleState State { get; set; }

Optional. State of the audit schedule. While most states are managed by the system, you can use [UpdateAuditSchedule][google.cloud.auditmanager.v1.AuditManager.UpdateAuditSchedule] to start, pause, or delete the schedule.

Property Value
Type Description
ScheduleState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the schedule was last updated.

Property Value
Type Description
Timestamp