genai-toolbox/docs/en/resources/tools/cloudsql/cloudsqlrestorebackup.md at 4d58cccb2bfbd71ea533b85e52e99cedd66325e2

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-29 01:08:01 -05:00

Files

Yuan Teoh 10c445b05c docs: update cloudsqlrestorebackup docs with new config format (#2381 )

Update docs example for `cloudsqlrestorebackup`.

2026-01-28 13:58:52 -08:00

2.4 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
cloud-sql-restore-backup	docs	10	Restores a backup of a Cloud SQL instance.

The cloud-sql-restore-backup tool restores a backup on a Cloud SQL instance using the Cloud SQL Admin API.

{{< notice info dd>}} This tool uses a source of type cloud-sql-admin. {{< /notice >}}

Examples

Basic backup restore

kind: tools
name: backup-restore-basic
type: cloud-sql-restore-backup
source: cloud-sql-admin-source
description: "Restores a backup onto the given Cloud SQL instance."

Reference

Tool Configuration

field	type	required	description
type	string	true	Must be "cloud-sql-restore-backup".
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

Tool Inputs

parameter	type	required	description
target_project	string	true	The project ID of the instance to restore the backup onto.
target_instance	string	true	The instance to restore the backup onto. Does not include the project ID.
backup_id	string	true	The identifier of the backup being restored.
source_project	string	false	(Optional) The project ID of the instance that the backup belongs to.
source_instance	string	false	(Optional) Cloud SQL instance ID of the instance that the backup belongs to.

Usage Notes

The backup_id field can be a BackupRun ID (which will be an int64), backup name, or BackupDR backup name.
If the backup_id field contains a BackupRun ID (i.e. an int64), the optional fields source_project and source_instance must also be provided.

2.4 KiB Raw Blame History