Resource: BackupSchedule
A backup schedule for a Cloud Firestore Database.
This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "retention": string, // Union field |
Fields | |
---|---|
name |
Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is |
createTime |
Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as createTime. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
retention |
At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. A duration in seconds with up to nine fractional digits, ending with ' |
Union field recurrence . A oneof field to represent when backups will be taken. recurrence can be only one of the following: |
|
dailyRecurrence |
For a schedule that runs daily. |
weeklyRecurrence |
For a schedule that runs weekly on a specific day. |
DailyRecurrence
This type has no fields.
Represents a recurring schedule that runs every day.
The time zone is UTC.
WeeklyRecurrence
Represents a recurring schedule that runs on a specified day of the week.
The time zone is UTC.
JSON representation |
---|
{
"day": enum ( |
Fields | |
---|---|
day |
The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. |
DayOfWeek
Represents a day of the week.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
The day of the week is unspecified. |
MONDAY |
Monday |
TUESDAY |
Tuesday |
WEDNESDAY |
Wednesday |
THURSDAY |
Thursday |
FRIDAY |
Friday |
SATURDAY |
Saturday |
SUNDAY |
Sunday |
Methods |
|
---|---|
|
Creates a backup schedule on a database. |
|
Deletes a backup schedule. |
|
Gets information about a backup schedule. |
|
List backup schedules. |
|
Updates a backup schedule. |