Reference documentation and code samples for the Cloud Spanner V1 Client class CrontabSpec.
CrontabSpec can be used to specify the version time and frequency at which the backup should be created.
Generated from protobuf message google.spanner.admin.database.v1.CrontabSpec
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
string
Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * |
↳ time_zone |
string
Output only. The time zone of the times in |
↳ creation_window |
Google\Protobuf\Duration
Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in |
getText
Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.
The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:
0 2/12 * * *
: every 12 hours at (2, 14) hours past midnight in UTC.0 2,14 * * *
: every 12 hours at (2,14) hours past midnight in UTC.0 2 * * *
: once a day at 2 past midnight in UTC.0 2 * * 0
: once a week every Sunday at 2 past midnight in UTC.0 2 8 * *
: once a month on 8th day at 2 past midnight in UTC.
Returns | |
---|---|
Type | Description |
string |
setText
Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone.
The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications:
0 2/12 * * *
: every 12 hours at (2, 14) hours past midnight in UTC.0 2,14 * * *
: every 12 hours at (2,14) hours past midnight in UTC.0 2 * * *
: once a day at 2 past midnight in UTC.0 2 * * 0
: once a week every Sunday at 2 past midnight in UTC.0 2 8 * *
: once a month on 8th day at 2 past midnight in UTC.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getTimeZone
Output only. The time zone of the times in CrontabSpec.text
. Currently
only UTC is supported.
Returns | |
---|---|
Type | Description |
string |
setTimeZone
Output only. The time zone of the times in CrontabSpec.text
. Currently
only UTC is supported.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreationWindow
Output only. Schedule backups will contain an externally consistent copy
of the database at the version time specified in
schedule_spec.cron_spec
. However, Spanner may not initiate the creation
of the scheduled backups at that version time. Spanner will initiate
the creation of scheduled backups within the time window bounded by the
version_time specified in schedule_spec.cron_spec
and version_time +
creation_window
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasCreationWindow
clearCreationWindow
setCreationWindow
Output only. Schedule backups will contain an externally consistent copy
of the database at the version time specified in
schedule_spec.cron_spec
. However, Spanner may not initiate the creation
of the scheduled backups at that version time. Spanner will initiate
the creation of scheduled backups within the time window bounded by the
version_time specified in schedule_spec.cron_spec
and version_time +
creation_window
.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |