backup_schedules

Overview

Name	backup_schedules
Type	Resource
Id	google.firestore.backup_schedules

Fields

Name	Datatype	Description
name	string	Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
createTime	string	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.
dailyRecurrence	object	Represent a recurring schedule that runs at a specific time every day. The time zone is UTC.
retention	string	At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
updateTime	string	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 create_time.
weeklyRecurrence	object	Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	backupSchedulesId, databasesId, projectsId	Gets information about a backup schedule.
list	SELECT	databasesId, projectsId	List backup schedules.
create	INSERT	databasesId, projectsId	Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.
delete	DELETE	backupSchedulesId, databasesId, projectsId	Deletes a backup schedule.
patch	EXEC	backupSchedulesId, databasesId, projectsId	Updates a backup schedule.