Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class ScheduleConfig.
Timing and frequency parameters for recurring audit runs.
Generated from protobuf message google.cloud.auditmanager.v1.ScheduleConfig
Namespace
Google \ Cloud \ AuditManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
Required. Date and time when the first audit run is triggered. Subsequent runs are based on this time and the chosen frequency. |
↳ end_time |
Google\Protobuf\Timestamp
Optional. Date that the schedule stops. If not specified, the schedule runs indefinitely. |
↳ frequency |
int
Required. Frequency of audit runs. |
↳ time_zone |
string
Optional. Time zone for the audit schedule in IANA format (for example, |
getStartTime
Required. Date and time when the first audit run is triggered.
Subsequent runs are based on this time and the chosen frequency.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Required. Date and time when the first audit run is triggered.
Subsequent runs are based on this time and the chosen frequency.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Optional. Date that the schedule stops.
If not specified, the schedule runs indefinitely.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Optional. Date that the schedule stops.
If not specified, the schedule runs indefinitely.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrequency
Required. Frequency of audit runs.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Frequency. |
setFrequency
Required. Frequency of audit runs.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Frequency. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimeZone
Optional. Time zone for the audit schedule in IANA format (for example,
America/New_York). The time zone is used to interpret the start_time
and the end_time, and to calculate subsequent run dates.
If not specified, the time zone default is UTC.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTimeZone
Optional. Time zone for the audit schedule in IANA format (for example,
America/New_York). The time zone is used to interpret the start_time
and the end_time, and to calculate subsequent run dates.
If not specified, the time zone default is UTC.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|