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

ProjectsLocationsBackups

class ProjectsLocationsBackups extends Resource (View source)

The "backups" collection of methods.

Typical usage is:

 $firestoreService = new Google\Service\Firestore(...);
 $backups = $firestoreService->projects_locations_backups;

Methods

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

Deletes a backup. (backups.delete)

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

Gets information about a backup. (backups.get)

GoogleFirestoreAdminV1ListBackupsResponse
listProjectsLocationsBackups(string $parent, array $optParams = [])

Lists all the backups. (backups.listProjectsLocationsBackups)

Details

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

Deletes a backup. (backups.delete)

Parameters

string $name

Required. Name of the backup to delete. format is projects/{project}/locations/{location}/backups/{backup}.
array $optParams

Optional parameters.

Return Value

FirestoreEmpty

Exceptions

Exception

at line 58
GoogleFirestoreAdminV1Backup get(string $name, array $optParams = [])

Gets information about a backup. (backups.get)

Parameters

string $name

Required. Name of the backup to fetch. Format is projects/{project}/locations/{location}/backups/{backup}.
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1Backup

Exceptions

Exception

at line 75
GoogleFirestoreAdminV1ListBackupsResponse listProjectsLocationsBackups(string $parent, array $optParams = [])

Lists all the backups. (backups.listProjectsLocationsBackups)

Parameters

string $parent

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.
array $optParams

Optional parameters.

Return Value

GoogleFirestoreAdminV1ListBackupsResponse

Exceptions

Exception