Reference documentation and code samples for the Google Cloud Audit Manager V1 Client 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}
Generated from protobuf message google.cloud.auditmanager.v1.AuditSchedule
Namespace
Google \ Cloud \ AuditManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
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} |
↳ display_name |
string
Optional. Display name for the audit schedule. |
↳ gcs_uri |
string
Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is |
↳ compliance_framework |
string
Required. Framework (set of controls) that the audit scope report is generated against. For example, |
↳ report_format |
int
Required. Format for the audit report. |
↳ schedule_config |
ScheduleConfig
Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule. |
↳ state |
int
Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the schedule was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the schedule was last updated. |
↳ next_run_time |
Google\Protobuf\Timestamp
Output only. Calculated timestamp for the next scheduled run. |
↳ last_trigger_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the audit run was last triggered. |
↳ error_message |
string
Output only. Describes the error if the schedule is in an error state. |
getName
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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name for the audit schedule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name for the audit schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcsUri
Required. Cloud Storage bucket where Audit Manager can upload the audit
report and evidence. The format is gs://{bucket_name}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcsUri
Required. Cloud Storage bucket where Audit Manager can upload the audit
report and evidence. The format is gs://{bucket_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComplianceFramework
Required. Framework (set of controls) that the audit scope report is
generated against. For example, NIST_800_53.
| Returns | |
|---|---|
| Type | Description |
string |
|
setComplianceFramework
Required. Framework (set of controls) that the audit scope report is
generated against. For example, NIST_800_53.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReportFormat
Required. Format for the audit report.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AuditReportFormat. |
setReportFormat
Required. Format for the audit report.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AuditReportFormat. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScheduleConfig
Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
| Returns | |
|---|---|
| Type | Description |
ScheduleConfig|null |
|
hasScheduleConfig
clearScheduleConfig
setScheduleConfig
Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
ScheduleConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ScheduleState. |
setState
Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ScheduleState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when the schedule was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the schedule was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when the schedule was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the schedule was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextRunTime
Output only. Calculated timestamp for the next scheduled run.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasNextRunTime
clearNextRunTime
setNextRunTime
Output only. Calculated timestamp for the next scheduled run.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastTriggerTime
Output only. Timestamp when the audit run was last triggered.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastTriggerTime
clearLastTriggerTime
setLastTriggerTime
Output only. Timestamp when the audit run was last triggered.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorMessage
Output only. Describes the error if the schedule is in an error state.
| Returns | |
|---|---|
| Type | Description |
string |
|
setErrorMessage
Output only. Describes the error if the schedule is in an error state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|