HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/lib/googlecloudsdk/api_lib/firestore/backups.py
# -*- coding: utf-8 -*- #
# Copyright 2023 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Useful commands for interacting with the Cloud Firestore Backups API."""


from googlecloudsdk.api_lib.firestore import api_utils
from googlecloudsdk.core import log


def _GetBackupService():
  """Returns the service for interacting with the Firestore Backup service."""
  return api_utils.GetClient().projects_locations_backups


def ListBackups(project, location):
  """Lists backups available to Google Cloud Firestore.

  Args:
    project: the project id to list backups, a string.
    location: the location to list backups, a string.

  Returns:
    a List of Backups.
  """
  result = _GetBackupService().List(
      api_utils.GetMessages().FirestoreProjectsLocationsBackupsListRequest(
          parent='projects/{}/locations/{}'.format(project, location)
      )
  )
  if result.unreachable:
    for unreachable in result.unreachable:
      log.status.Print(
          f'Failed to list backups for location {unreachable}, please retry'
          ' with command gcloud {version} firestore backups list'
          f' --location={unreachable} to get a more concrete error'
      )
  return list(result.backups)


def GetBackup(project, location, backup):
  """Gets backup with the given name.

  Args:
    project: the project id to get backup, a string.
    location: the location to get backup, a string.
    backup: the backup id to get backup, a string.

  Returns:
    A Backup.
  """
  return _GetBackupService().Get(
      api_utils.GetMessages().FirestoreProjectsLocationsBackupsGetRequest(
          name='projects/{}/locations/{}/backups/{}'.format(
              project, location, backup
          )
      )
  )


def DeleteBackup(project, location, backup):
  """Deletes backup with the given name.

  Args:
    project: the project id to get backup, a string.
    location: the location to get backup, a string.
    backup: the backup id to get backup, a string.

  Returns:
    Empty.
  """

  return _GetBackupService().Delete(
      api_utils.GetMessages().FirestoreProjectsLocationsBackupsDeleteRequest(
          name='projects/{}/locations/{}/backups/{}'.format(
              project, location, backup
          )
      )
  )