1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Firestore
  7. \
  8. Resource
  9. \
  10. ProjectsDatabasesBackupSchedules

ProjectsDatabasesBackupSchedules

class ProjectsDatabasesBackupSchedules extends Resource (View source)

The "backupSchedules" collection of methods.

Typical usage is:

 $firestoreService = new Google\Service\Firestore(...);
 $backupSchedules = $firestoreService->projects_databases_backupSchedules;

Methods

GoogleFirestoreAdminV1BackupSchedule
create(string $parent, GoogleFirestoreAdminV1BackupSchedule $postBody, array $optParams = [])

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule. (backupSchedules.create)

FirestoreEmpty
delete(string $name, array $optParams = [])

Deletes a backup schedule. (backupSchedules.delete)

GoogleFirestoreAdminV1BackupSchedule
get(string $name, array $optParams = [])

Gets information about a backup schedule. (backupSchedules.get)

GoogleFirestoreAdminV1ListBackupSchedulesResponse
listProjectsDatabasesBackupSchedules(string $parent, array $optParams = [])

List backup schedules. (backupSchedules.listProjectsDatabasesBackupSchedules)

GoogleFirestoreAdminV1BackupSchedule
patch(string $name, GoogleFirestoreAdminV1BackupSchedule $postBody, array $optParams = [])

Updates a backup schedule. (backupSchedules.patch)

Details

at line 46
GoogleFirestoreAdminV1BackupSchedule create(string $parent, GoogleFirestoreAdminV1BackupSchedule $postBody, array $optParams = [])

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule. (backupSchedules.create)

Parameters

string $parent

Required. The parent database. Format projects/{project}/databases/{database}
GoogleFirestoreAdminV1BackupSchedule $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1BackupSchedule

Exceptions

Exception

at line 61
FirestoreEmpty delete(string $name, array $optParams = [])

Deletes a backup schedule. (backupSchedules.delete)

Parameters

string $name

Required. The name of the backup schedule. Format projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
array $optParams

Optional parameters.

Return Value

FirestoreEmpty

Exceptions

Exception

at line 76
GoogleFirestoreAdminV1BackupSchedule get(string $name, array $optParams = [])

Gets information about a backup schedule. (backupSchedules.get)

Parameters

string $name

Required. The name of the backup schedule. Format projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1BackupSchedule

Exceptions

Exception

at line 91
GoogleFirestoreAdminV1ListBackupSchedulesResponse listProjectsDatabasesBackupSchedules(string $parent, array $optParams = [])

List backup schedules. (backupSchedules.listProjectsDatabasesBackupSchedules)

Parameters

string $parent

Required. The parent database. Format is projects/{project}/databases/{database}.
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1ListBackupSchedulesResponse

Exceptions

Exception

at line 111
GoogleFirestoreAdminV1BackupSchedule patch(string $name, GoogleFirestoreAdminV1BackupSchedule $postBody, array $optParams = [])

Updates a backup schedule. (backupSchedules.patch)

Parameters

string $name

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}
GoogleFirestoreAdminV1BackupSchedule $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1BackupSchedule

Exceptions

Exception