2023-05-12
▼ ▲ firestore.projects.locations.backups.delete
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
Scopes:
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. Name of the backup to delete. format is `projects/{project}/locations/{location}/backups/{backup}`.
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Description: Deletes a backup.
▼ ▲ firestore.projects.locations.backups.get
Parameter Order: name
Parameters:
name
Description: Required. Name of the backup to fetch. Format is `projects/{project}/locations/{location}/backups/{backup}`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
HTTP Method: GET
Description: Gets information about a backup.
Scopes:
Path: v1/{+name}
▼ ▲ firestore.projects.locations.backups.list
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backups
Scopes:
Path: v1/{+parent}/backups
Description: Lists all the backups.
Parameters:
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.
Type: string
▼ ▲ firestore.projects.databases.restore
Flat Path: v1/projects/{projectsId}/databases:restore
Scopes:
Parameter Order: parent
Description: Create a new database by restore from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed. Cancelling the returned operation will stop the restore and delete the in-progress database, if the restore is still active.
Parameters:
parent
Pattern: ^projects/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The project to restore the database in. Format is `projects/{project_id}`.
HTTP Method: POST
Path: v1/{+parent}/databases:restore
▼ ▲ firestore.projects.databases.backupSchedules.list
Flat Path: v1/projects/{projectsId}/databases/{databasesId}/backupSchedules
Path: v1/{+parent}/backupSchedules
HTTP Method: GET
Parameters:
parent
Type: string
Description: Required. The parent database. Format is `projects/{project}/databases/{database}`.
Required: Yes
Pattern: ^projects/[^/]+/databases/[^/]+$
Location: path
Description: List backup schedules.
Scopes:
Parameter Order: parent
▼ ▲ firestore.projects.databases.backupSchedules.get
Parameter Order: name
Description: Gets information about a backup schedule.
Scopes:
Path: v1/{+name}
Parameters:
name
Description: Required. The name of the backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
▼ ▲ firestore.projects.databases.backupSchedules.patch
Flat Path: v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
Description: Updates a backup schedule.
Scopes:
Parameter Order: name
Parameters:
updateMask
Description: The list of fields to be updated.
Type: string
Format: google-fieldmask
Location: query
name
Location: path
Pattern: ^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Description: 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}`
Type: string
Required: Yes
Path: v1/{+name}
HTTP Method: PATCH
▼ ▲ firestore.projects.databases.backupSchedules.create
Scopes:
Parameter Order: parent
HTTP Method: POST
Description: 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.
Flat Path: v1/projects/{projectsId}/databases/{databasesId}/backupSchedules
Parameters:
parent
Pattern: ^projects/[^/]+/databases/[^/]+$
Description: Required. The parent database. Format `projects/{project}/databases/{database}`
Location: path
Type: string
Required: Yes
Path: v1/{+parent}/backupSchedules
▼ ▲ firestore.projects.databases.backupSchedules.delete
HTTP Method: DELETE
Description: Deletes a backup schedule.
Path: v1/{+name}
Scopes:
Parameter Order: name
Flat Path: v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
Parameters:
name
Type: string
Description: Required. The name of backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
Required: Yes
Pattern: ^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path