Reference documentation and code samples for the Cloud Firestore V1 Client class 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.
Generated from protobuf messagegoogle.firestore.admin.v1.BackupSchedule
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format isprojects/{project}/databases/{database}/backupSchedules/{backup_schedule}
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class BackupSchedule (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.BackupSchedule)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.BackupSchedule)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.BackupSchedule)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.BackupSchedule)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.BackupSchedule)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.BackupSchedule)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.BackupSchedule)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.BackupSchedule)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.BackupSchedule)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.BackupSchedule)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.BackupSchedule)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.BackupSchedule)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.BackupSchedule)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.BackupSchedule)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.BackupSchedule)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.BackupSchedule)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.BackupSchedule)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.BackupSchedule)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.BackupSchedule)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.BackupSchedule)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.BackupSchedule)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.BackupSchedule)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.BackupSchedule) \nReference documentation and code samples for the Cloud Firestore V1 Client class BackupSchedule.\n\nA backup schedule for a Cloud Firestore Database.\n\nThis resource is owned by the database it is backing up, and is deleted along\nwith the database. The actual backups are not though.\n\nGenerated from protobuf message `google.firestore.admin.v1.BackupSchedule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The unique backup schedule identifier across all locations and\ndatabases for the given project.\n\nThis will be auto-assigned.\nFormat is\n`projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`\n\n### setName\n\nOutput only. The unique backup schedule identifier across all locations and\ndatabases for the given project.\n\nThis will be auto-assigned.\nFormat is\n`projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`\n\n### getCreateTime\n\nOutput only. The timestamp at which this backup schedule was created and\neffective since.\n\nNo backups will be created for this schedule before this time.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The timestamp at which this backup schedule was created and\neffective since.\n\nNo backups will be created for this schedule before this time.\n\n### getUpdateTime\n\nOutput only. The timestamp at which this backup schedule was most recently\nupdated. When a backup schedule is first created, this is the same as\ncreate_time.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The timestamp at which this backup schedule was most recently\nupdated. When a backup schedule is first created, this is the same as\ncreate_time.\n\n### getRetention\n\nAt what relative time in the future, compared to its creation time,\nthe backup should be deleted, e.g. keep backups for 7 days.\n\nThe maximum supported retention period is 14 weeks.\n\n### hasRetention\n\n### clearRetention\n\n### setRetention\n\nAt what relative time in the future, compared to its creation time,\nthe backup should be deleted, e.g. keep backups for 7 days.\n\nThe maximum supported retention period is 14 weeks.\n\n### getDailyRecurrence\n\nFor a schedule that runs daily.\n\n### hasDailyRecurrence\n\n### setDailyRecurrence\n\nFor a schedule that runs daily.\n\n### getWeeklyRecurrence\n\nFor a schedule that runs weekly on a specific day.\n\n### hasWeeklyRecurrence\n\n### setWeeklyRecurrence\n\nFor a schedule that runs weekly on a specific day.\n\n### getRecurrence"]]
