backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	google.sqladmin.backups

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete_backup	exec	projectsId, backupsId		Deletes the backup.
get_backup	exec	projectsId, backupsId		Retrieves a resource containing information about a backup.
update_backup	exec	projectsId, backupsId	updateMask	Updates the retention period and description of the backup. You can use this API to update final backups only.
list_backups	exec	projectsId	pageToken, filter, pageSize	Lists all backups associated with the project.
create_backup	exec	projectsId		Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

Lifecycle Methods

delete_backup

Deletes the backup.

EXEC google.sqladmin.backups.delete_backup 
@projectsId='{{ projectsId }}' --required, 
@backupsId='{{ backupsId }}' --required
;

get_backup

Retrieves a resource containing information about a backup.

EXEC google.sqladmin.backups.get_backup 
@projectsId='{{ projectsId }}' --required, 
@backupsId='{{ backupsId }}' --required
;

update_backup

Updates the retention period and description of the backup. You can use this API to update final backups only.

EXEC google.sqladmin.backups.update_backup 
@projectsId='{{ projectsId }}' --required, 
@backupsId='{{ backupsId }}' --required, 
@updateMask='{{ updateMask }}' 
@@json=
'{
"expiryTime": "{{ expiryTime }}", 
"description": "{{ description }}", 
"instance": "{{ instance }}", 
"location": "{{ location }}", 
"ttlDays": "{{ ttlDays }}"
}'
;

list_backups

Lists all backups associated with the project.

EXEC google.sqladmin.backups.list_backups 
@projectsId='{{ projectsId }}' --required, 
@pageToken='{{ pageToken }}', 
@filter='{{ filter }}', 
@pageSize='{{ pageSize }}'
;

create_backup

Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.

EXEC google.sqladmin.backups.create_backup 
@projectsId='{{ projectsId }}' --required 
@@json=
'{
"expiryTime": "{{ expiryTime }}", 
"description": "{{ description }}", 
"instance": "{{ instance }}", 
"location": "{{ location }}", 
"ttlDays": "{{ ttlDays }}"
}'
;