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 message google.firestore.admin.v1.BackupSchedule
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__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 is |
↳ create_time |
Google\Protobuf\Timestamp
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. |
↳ update_time |
Google\Protobuf\Timestamp
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. |
↳ retention |
Google\Protobuf\Duration
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. |
↳ daily_recurrence |
DailyRecurrence
For a schedule that runs daily. |
↳ weekly_recurrence |
WeeklyRecurrence
For a schedule that runs weekly on a specific day. |
getName
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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetention
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasRetention
clearRetention
setRetention
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDailyRecurrence
For a schedule that runs daily.
| Returns | |
|---|---|
| Type | Description |
DailyRecurrence|null |
|
hasDailyRecurrence
setDailyRecurrence
For a schedule that runs daily.
| Parameter | |
|---|---|
| Name | Description |
var |
DailyRecurrence
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWeeklyRecurrence
For a schedule that runs weekly on a specific day.
| Returns | |
|---|---|
| Type | Description |
WeeklyRecurrence|null |
|
hasWeeklyRecurrence
setWeeklyRecurrence
For a schedule that runs weekly on a specific day.
| Parameter | |
|---|---|
| Name | Description |
var |
WeeklyRecurrence
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecurrence
| Returns | |
|---|---|
| Type | Description |
string |
|